Inheritance diagram for GenerallyPositive.Browser.PuppeteerClient:

Public Member Functions
IPuppeteerClient	ToGPALObject ()
	Returns this client cast to its public IPuppeteerClient interface.
IAllowPuppeteerEndpointDetails	WithPuppeteerCommunicator (PuppeteerCommunicator communicator)
	Sets the PuppeteerCommunicator used to send commands to the puppeteer/CDP server.
IAllowPuppeteerParametersOrExecution	WithEndpoint (string endpoint)
	Sets a custom endpoint path to call directly, bypassing the built-in ApiEndpoint enum.
IAllowPuppeteerParametersOrExecution	WithEndpoint (ApiEndpoint endpoint)
	Sets the endpoint to call, resolved from the given ApiEndpoint value. Parameters set before this call survive it, so the endpoint and its parameters can be named in either order.
IAllowPuppeteerParametersOrExecution	WithResultName (string name)
	Sets the name under which this execution's result will be stored, for later retrieval via the WithXFromResult methods.
IAllowPuppeteerEndpointDetails	WithSaveFile (GPALFile file)
IAllowPuppeteerParametersOrExecution	WithSessionToken (string sessionToken)
	Sets the session token parameter for the request.
IAllowPuppeteerEndpointDetails	WithName (string name)
	Sets the display name for this client.
IAllowPuppeteerParametersOrExecution	WithUrl (string url)
	Sets the url parameter for the request.
IAllowPuppeteerParametersOrExecution	WithUrlFromResult (int resultIndex)
	Sets the url parameter from the result at the given index of a previous execution.
IAllowPuppeteerParametersOrExecution	WithUrlFromResult (string name)
	Sets the url parameter from the named result of a previous execution.
IAllowPuppeteerParametersOrExecution	WithTabId (int tabId)
	Sets the tab id parameter for the request.
IAllowPuppeteerParametersOrExecution	WithTabIdFromResult (int resultIndex)
	Sets the tab id parameter from the result at the given index of a previous execution.
IAllowPuppeteerParametersOrExecution	WithTabIdFromResult (string name)
	Sets the tab id parameter from the named result of a previous execution.
IAllowPuppeteerParametersOrExecution	WithWindowId (int windowId)
	Sets the window id parameter for the request.
IAllowPuppeteerParametersOrExecution	WithWindowIdFromResult (int resultIndex)
	Sets the window id parameter from the result at the given index of a previous execution.
IAllowPuppeteerParametersOrExecution	WithWindowIdFromResult (string name)
	Sets the window id parameter from the named result of a previous execution.
IAllowPuppeteerStorageOptions	WithStorageDomain (string domain)
	Sets the storage domain parameter for storage operations.
IAllowPuppeteerStorageOptions	WithStoragePath (string path)
	Sets the storage path parameter for storage operations.
IAllowPuppeteerStorageOptions	WithStorageKey (string key)
	Sets the storage key parameter for storage operations.
IAllowPuppeteerStorageOptions	WithStorageStoreName (string storeName)
	Sets the storage store name parameter for IndexedDB storage operations.
IAllowPuppeteerStorageOptions	WithStorageData (string data)
	Sets the storage data parameter for storage operations.
IAllowPuppeteerStorageOptions	WithDeleteAcrossOrigins (bool trueOrFalse)
	Sets whether storage should be deleted across all origins, not just the current one.
IAllowPuppeteerParametersOrExecution	WithKey (string key)
	Sets the key parameter for the request.
IAllowPuppeteerParametersOrExecution	WithKeyFromResult (int resultIndex)
	Sets the key parameter from the result at the given index of a previous execution.
IAllowPuppeteerParametersOrExecution	WithKeyFromResult (string name)
	Sets the key parameter from the named result of a previous execution.
IAllowPuppeteerParametersOrExecution	WithCss (string css)
	Sets the css selector parameter for the request.
IAllowPuppeteerParametersOrExecution	WithCssFromResult (int resultIndex)
	Sets the css selector parameter from the result at the given index of a previous execution.
IAllowPuppeteerParametersOrExecution	WithCssFromResult (string name)
	Sets the css selector parameter from the named result of a previous execution.
IAllowPuppeteerParametersOrExecution	WithElements (List< GPALElement > gpalElements)
	Sets the gpalElements parameter, identifying the elements the request should act on.
IAllowPuppeteerParametersOrExecution	WithElementFromResult (int resultIndex)
	Sets the elementId parameter from the result at the given index of a previous execution, then calls WithElementId.
IAllowPuppeteerParametersOrExecution	WithElementFromResult (string name)
	Sets the elementId parameter from the named result of a previous execution, then calls WithElementId.
IAllowPuppeteerParametersOrExecution	WithIteration (int iteration)
	Sets the iteration for an endpoint to retrieve from the results when using WithXXXFromResults.
IAllowPuppeteerParametersOrExecution	WithXPath (string xpath)
	Sets the xpath parameter for the request.
IAllowPuppeteerParametersOrExecution	WithXPathFromResult (int resultIndex)
	Sets the xpath parameter from the result at the given index of a previous execution.
IAllowPuppeteerParametersOrExecution	WithXPathFromResult (string name)
	Sets the xpath parameter from the named result of a previous execution.
IAllowPuppeteerParametersOrExecution	WithPixels (int pixels)
	Sets the pixels parameter for the request.
IAllowPuppeteerParametersOrExecution	WithPixelsFromResult (int resultIndex)
	Sets the pixels parameter from the result at the given index of a previous execution.
IAllowPuppeteerParametersOrExecution	WithPixelsFromResult (string name)
	Sets the pixels parameter from the named result of a previous execution.
IAllowPuppeteerParametersOrExecution	WithReferrer (string referrer)
	Sets the referrer parameter for the request.
IAllowPuppeteerParametersOrExecution	WithReferrerFromResult (int resultIndex)
	Sets the referrer parameter from the result at the given index of a previous execution.
IAllowPuppeteerParametersOrExecution	WithReferrerFromResult (string name)
	Sets the referrer parameter from the named result of a previous execution.
IAllowPuppeteerExecution	WithText (string text)
	Sets the text parameter for the request.
IAllowPuppeteerExecution	WithTextFromResult (int resultIndex)
	Sets the text parameter from the result at the given index of a previous execution.
IAllowPuppeteerExecution	WithTextFromResult (string name)
	Sets the text parameter from the named result of a previous execution.
IAllowPuppeteerParametersOrExecution	DownloadTo (GPALFile file)
	Where a file the browser downloads should end up. Not SaveTo, which is GPAL writing a file it already has. Only the directory of file reaches the browser, since CDP sets where a download lands and not what it is called; the download watcher gives it the name that was asked for.
IAllowPuppeteerParametersOrExecution	WithElementId (string selector)
	Sets the elementId parameter for the request, resolving CSS selectors to an element handle if needed.
IAllowPuppeteerParametersOrExecution	WithElementIdFromResult (int resultIndex)
	Sets the elementId parameter from the result at the given index of a previous execution, then calls WithElementId.
IAllowPuppeteerParametersOrExecution	WithElementIdFromResult (string name)
	Sets the elementId parameter from the named result of a previous execution, then calls WithElementId.
IAllowPuppeteerParametersOrExecution	WithHPixelsFromResult (int resultIndex)
	Sets the horizontal pixels parameter from the result at the given index of a previous execution.
IAllowPuppeteerParametersOrExecution	WithHPixelsFromResult (string name)
	Sets the horizontal pixels parameter from the named result of a previous execution.
IAllowPuppeteerParametersOrExecution	WithVPixelsFromResult (int resultIndex)
	Sets the vertical pixels parameter from the result at the given index of a previous execution.
IAllowPuppeteerParametersOrExecution	WithVPixelsFromResult (string name)
	Sets the vertical pixels parameter from the named result of a previous execution.
string	Execute ()
	Synchronously executes the configured request and returns the result as a string.
T	Execute< T > ()
IPuppeteerClient	AndThen ()
	Executes the configured request, then returns this client so further fluent calls can configure the next request.
IPuppeteerClient	AndThen< T > ()
async Task< string >	ExecuteAsync ()
	Asynchronously executes the configured request and returns the result as a string.
async Task< T >	ExecuteAsync< T > ()
IAllowPuppeteerWorkflow	ClearWorkflows ()
	Returns a collection of all named results recorded so far across this client's executions.
IAllowPuppeteerExecution	ClearResults ()
	Empties what `WithResultName` has stored, so `GetExecutionResults` answers about what has happened since rather than everything since the client was made.
ResultCollection	GetExecutionResults ()
	Everything stored under a name so far, in the order it was stored. The target id a result was taken from is dropped here, since a caller asking by name is asking about the run rather than the tab.
IReadOnlyList< object >	GetExecutionResults (string name)
	Every result stored under name , in the order it was stored, so a loop that ran five times answers with five. Ask without a name for the whole collection, or index it by name for the last answer alone.
IAllowPuppeteerExecution	WithHeader (string name, string value)
	Sets an extra HTTP header to send with the request.
IAllowPuppeteerParametersOrExecution	WithParameters (params object[] parameters)
	Sets the request parameters as an ordinal array.
IAllowPuppeteerParametersOrExecution	WithParameters (object parameters)
	Sets the request parameters from an object with named fields.
IAllowPuppeteerParametersOrExecution	WithParametersFromResult (int resultIndex)
	Sets the request parameters from the result at the given index of a previous execution.
IAllowPuppeteerParametersOrExecution	WithParametersFromResult (string name)
	Sets the request parameters from the named result of a previous execution.
IAllowPuppeteerParametersOrExecution	WithEncoding (ContentEncoding encoding)
	Sets the content encoding used for requests sent to the puppeteer communicator.
IAllowPuppeteerWorkflow	WithWorkflow (Action< PuppeteerClient > workflow)
	Adds a workflow step that invokes the given action against this client.
IAllowPuppeteerWorkflow	WhileLoopTimeout (int timeoutMs)
	Sets the maximum time a subsequent While/Until loop may run before timing out.
IAllowPuppeteerWorkflow	WhileLoopMaxIterations (int maxIterations)
	Sets the maximum number of iterations a subsequent While/Until loop may run.
IAllowPuppeteerParametersOrExecution	While (Func< bool > condition)
IAllowPuppeteerParametersOrExecution	Until (Func< bool > condition)
	Configures execution to repeat until the given condition returns true, subject to WhileLoopTimeout/WhileLoopMaxIterations.
IAllowPuppeteerCheckNetworkIdleOrExecution	WithTimeoutMs (int timeoutMs)
	Sets the timeout, in milliseconds, used by CheckNetworkIdle.
IAllowPuppeteerCheckNetworkIdleOrExecution	WithPruneMs (int pruneMs)
	Sets the prune interval, in milliseconds, used by CheckNetworkIdle.
IAllowPuppeteerCheckNetworkIdleOrExecution	WithMaxConnections (int maxConnections)
	Sets the maximum number of in-flight connections allowed before the network is considered busy, used by CheckNetworkIdle.
IAllowPuppeteerParametersOrExecution	WithModifiers (ModifierKeys modifierKeys)
	Sets the modifier keys parameter for the request.
IAllowPuppeteerScrollElement	WithHPixels (int hPixels)
	Sets the horizontal pixels parameter for the request.
IAllowPuppeteerScrollElement	WithVPixels (int vPixels)
	Sets the vertical pixels parameter for the request.
IAllowPuppeteerDragAndDrop	WithDeltaX (int deltaX)
	Sets the horizontal drag delta parameter for a drag and drop.
IAllowPuppeteerDragAndDrop	WithDeltaY (int deltaY)
	Sets the vertical drag delta parameter for a drag and drop.
IAllowPuppeteerDragAndDrop	WithOffsetX (int offsetX)
	Sets the horizontal grab offset within the element for a drag and drop.
IAllowPuppeteerDragAndDrop	WithOffsetY (int offsetY)
	Sets the vertical grab offset within the element for a drag and drop.
IAllowPuppeteerAttribute	WithAttribute (string attribute)
	Sets the attribute name parameter for SetAttribute/GetAttribute requests.
IAllowPuppeteerAttribute	WithValue (string value)
	Sets the attribute value parameter for SetAttribute requests.
IAllowPuppeteerExecution	WithDestElementId (string destElementId)
	Sets the destination element id parameter for a drag and drop.
IAllowPuppeteerExecution	WithDeviceName (string sinkName)
	Sets the CSS parameter.
IAllowPuppeteerExecution	Back ()
	Configure this client to navigate the browser back one page in history.
IAllowPuppeteerExecution	CaptureVisibleTab (ImageFormat imageFormat=ImageFormat.JPEG)
	Configure this client to capture a screenshot of the visible tab in the given image format.
IAllowPuppeteerExecution	CastDesktop (string deviceNameOrId)
	Cast the desktop to the specified device name client.CastDesktop("living room").Execute();.
IAllowPuppeteerExecution	CastTab (string deviceNameOrId)
	Cast the current tab to the specified device name client.CastTab("living room").Execute();.
IAllowPuppeteerExecution	CloseTab (GPALUrl url=null)
	Configure this client to close the tab with the given URL, or the current tab if none is given.
IAllowPuppeteerExecution	CloseTab (int tabId)
	Configure this client to close the tab with the given tab id.
IAllowPuppeteerExecution	CloseWindow (GPALUrl url=null)
	Configure this client to close the window containing the given URL, or the current window if none is given.
IAllowPuppeteerExecution	CloseWindow (int tabId)
	Configure this client to close the window containing the tab with the given tab id.
IAllowPuppeteerStorageOptions	DeleteStorage (WebsiteStorageType storageType)
	Configure this client to delete the given type of website storage.
IAllowPuppeteerParameters	ExecuteJavaScript (string script)
	Configure this client to execute the given JavaScript in the page.
IAllowPuppeteerParametersOrExecution	Fetch (string url)
	Configure this client to issue an API request from inside the page, so it carries the session the browser has already earned: its cookies, TLS fingerprint, header order and any anti-bot clearance.
IAllowPuppeteerParametersOrExecution	WithVerb (string method)
	HTTP method for the request. GET when nothing was said.
IAllowPuppeteerParametersOrExecution	WithBody (string body)
	Body to send with the request.
IAllowPuppeteerParametersOrExecution	WithContentType (string contentType)
	Content type of the body.
IAllowPuppeteerParametersOrExecution	WithHeaders (string[] headers)
	Extra request headers, flattened to name, value, name, value.
IAllowPuppeteerParametersOrExecution	WithBytes (bool asBytes)
	True to bring the response body back base64 encoded, which is what a file needs. Text is the default, and reading a file as text would put a replacement character wherever a byte is not valid utf-8.
IAllowPuppeteerInputText	FillInAppend (dynamic elementOrelementId, int delayMs=0)
	Configure this client to append text to the given input element.
IAllowPuppeteerInputText	FillInInsert (dynamic elementOrelementId, int delayMs=0)
	Configure this client to insert text at the start of the given input element.
IAllowPuppeteerInputText	FillInOverwrite (dynamic elementOrelementId, int delayMs=0)
	Configure this client to overwrite the text of the given input element.
IAllowPuppeteerExecution	Forward ()
	Configure this client to navigate the browser forward one page in history.
IAllowPuppeteerExecution	FullScreen ()
	Configure this client to make the browser window fullscreen.
IAllowPuppeteerExecution	GetReadyStatus ()
	Configure this client to query the puppeteer server's ready status, optionally for a specific session token.
IAllowPuppeteerParametersOrExecution	CheckNetworkIdle (int maxConnections=0)
	Configure this client to check whether network activity has gone idle.
IAllowPuppeteerExecution	GetShadowRoot (string css)
	Configure this client to retrieve the shadow root of the element matching the given CSS selector.
IAllowPuppeteerExecution	GetCurrentUrl ()
	Configure this client to retrieve the current page URL.
IAllowPuppeteerExecution	GetCurrentWindow ()
	Configure this client to retrieve information about the current browser window.
IAllowPuppeteerStorageOptions	GetStorage (WebsiteStorageType storageType)
	Configure this client to retrieve the given type of website storage.
IAllowPuppeteerExecution	GetLanguages ()
	Configure this client to retrieve the browser's preferred languages, most preferred first.
IAllowPuppeteerExecution	GetUserAgent ()
	Configure this client to retrieve the browser's user agent string.
IAllowPuppeteerExecution	GoTo (GPALUrl url)
	Configure this client to navigate the current tab to the given URL, resolving relative URLs and checking robots.txt restrictions.
IAllowPuppeteerExecution	GoToTab (GPALUrl url)
	Configure this client to switch to the tab whose URL matches the given URL.
IAllowPuppeteerExecution	GoToTab (int tabId)
	Configure this client to switch to the tab with the given tab id.
IAllowPuppeteerExecution	GoToWindow (GPALUrl url)
	Configure this client to switch to the window containing the tab whose URL matches the given URL.
IAllowPuppeteerExecution	GoToWindow (int tabId)
	Configure this client to switch to the window containing the tab with the given tab id.
IAllowPuppeteerExecution	InElement (string selector)
	Configure this client to switch context into the element matching the given selector.
IAllowPuppeteerExecution	InMainDom ()
	Configure this client to switch context back to the main document.
IAllowPuppeteerExecution	InShadowDom (string selector)
	Configure this client to switch context into the shadow root of the element matching the given selector.
IAllowPuppeteerExecution	Maximize ()
	Configure this client to maximize the browser window.
IAllowPuppeteerExecution	Minimize ()
	Configure this client to minimize the browser window.
IAllowPuppeteerExecution	MoveTo (string selector)
	Configure this client to move the mouse to the element matching the given selector.
IAllowPuppeteerExecution	NewTab (GPALUrl url=null)
	Configure this client to open a new tab navigated to the given URL, resolving relative URLs and checking robots.txt restrictions.
IAllowPuppeteerExecution	NextTab ()
	Configure this client to switch to the next tab.
IAllowPuppeteerExecution	NextWindow ()
	Configure this client to switch to the next browser window.
IAllowPuppeteerExecution	Normal ()
	Configure this client to restore the browser window to its normal (non-maximized, non-minimized) state.
IAllowPuppeteerExecution	OpenWindow (GPALUrl url)
	Configure this client to open a new browser window navigated to the given URL, resolving relative URLs and checking robots.txt restrictions.
IAllowPuppeteerExecution	OverrideReferrer (string referrer)
	Configure this client to override the HTTP referrer sent with subsequent requests.
IAllowPuppeteerExecution	SetUserAgent (string userAgent)
	Configure this client to override the browser's user agent string for subsequent requests.
IAllowPuppeteerExecution	PageDown (int pagesToScroll=1)
	Configure this client to scroll the page down by the given number of page heights.
IAllowPuppeteerExecution	PageEnd ()
	Configure this client to scroll to the bottom of the page.
IAllowPuppeteerExecution	PageTop ()
	Configure this client to scroll to the top of the page.
IAllowPuppeteerExecution	PageUp (int pagesToScroll=1)
	Configure this client to scroll the page up by the given number of page heights.
IAllowPuppeteerExecution	PreviousTab ()
	Configure this client to switch to the previous tab.
IAllowPuppeteerExecution	PreviousWindow ()
	Configure this client to switch to the previous browser window.
IAllowPuppeteerExecution	Refresh ()
	Configure this client to refresh the current page.
IAllowPuppeteerExecution	PressModifierKey (ModifierKeys modifierKeys)
	Configure this client to press and hold the given modifier key(s).
IAllowPuppeteerExecution	ReleaseModifierKey (ModifierKeys modifierKeys)
	Configure this client to release the given modifier key(s).
int	GetModifierBitmask (ModifierKeys modifierKeys)
	Converts GPAL ModifierKeys flags to the equivalent Chrome DevTools Protocol modifiers bitmask.
string	GetModifiersString (int bitmask)
	Converts a Chrome DevTools Protocol modifiers bitmask back to a human-readable, plus-separated list of modifier names.
IAllowPuppeteerExecution	Restore ()
	Configure this client to restore the browser window to its normal size.
IAllowPuppeteerParametersOrExecution	LeftClickAndDownload (string selector)
	Configure this client to left-click the given element and download the resulting target.
IAllowPuppeteerExecution	ScrollWindowByHorizontal (int pixels)
	Configure this client to scroll the browser window horizontally by the given number of pixels.
IAllowPuppeteerExecution	ScrollWindowByVertical (int pixels)
	Configure this client to scroll the browser window vertically by the given number of pixels.
IAllowPuppeteerExecution	SendString (string text, int delayMs=0)
	Configure this client to type the given text into the focused element.
IAllowPuppeteerExecution	SendKey (byte vkcode)
	Configure this client to send a key press for the given virtual key code, translating it to the corresponding DOM key and code.
IAllowPuppeteerExecution	SetGoogleReferrer ()
	Configure this client to override the HTTP referrer with https://www.google.com, to mimic arriving from a search engine.
IAllowPuppeteerExecution	StopCasting ()
	Configure this client to stop any active screen casting.
IAllowPuppeteerExecution	SwitchToDefaultContent ()
	Configure this client to switch context back to the main document.
IAllowPuppeteerExecution	SwitchToElement (string selector)
	Configure this client to switch context into the element matching the given selector.
IAllowPuppeteerExecution	SwitchToFrame (string selector)
	Configure this client to switch context into the iframe matching the given selector.
IAllowPuppeteerExecution	SwitchToShadowRoot (string selector)
	Configure this client to switch context into the shadow root of the element matching the given selector.
IAllowPuppeteerExecution	InjectScript (string script)
	Configure this client to inject the given JavaScript into the page.
IAllowPuppeteerExecution	ClearInjectedScripts ()
	Configure this client to remove all previously injected scripts (via InjectScript(string)).
IAllowPuppeteerExecution	DownloadTo (string downloadPath)
	Where files the browser downloads should end up. Not SaveTo, which is GPAL writing a file it already has. This sets the directory CDP sends downloads to.
IAllowPuppeteerExecution	FireChangeEvent (string selector)
	Configure this client to fire a DOM change event on the given element.
IAllowPuppeteerExecution	Focus (string selector)
	Configure this client to set keyboard focus on the given element.
IAllowPuppeteerExecution	GetBoundingClientRect (string backendNodeId)
	Configure this client to retrieve the bounding client rectangle of the given element.
IAllowPuppeteerExecution	GetElementAttributeHash (string selector)
	Configure this client to compute a hash of the given element's attributes, useful for detecting element changes.
IAllowPuppeteerExecution	GetPageSource ()
	Configure this client to retrieve the current page's HTML source.
IAllowPuppeteerExecution	GetParentNode (string selector)
	Configure this client to retrieve the parent node of the given element.
IAllowPuppeteerExecution	GetContentAndCss (string selector)
	Configure this client to retrieve the text content and computed CSS of the given element.
IAllowPuppeteerExecution	GetCssAttributes (string selector)
	Configure this client to retrieve the CSS attributes of the given element.
IAllowPuppeteerExecution	GetDomAttributes (string selector)
	Configure this client to retrieve the DOM attributes of the given element.
IAllowPuppeteerExecution	GetDomProperties (string selector)
	Configure this client to retrieve the DOM properties of the given element.
IAllowPuppeteerExecution	HideElement (string selector)
	Configure this client to hide the given element.
IAllowPuppeteerExecution	IsClickable (string selector)
	Configure this client to check whether the given element is clickable.
IAllowPuppeteerExecution	IsDisplayed (string selector)
	Configure this client to check whether the given element is displayed.
IAllowPuppeteerExecution	IsEnabled (string selector)
	Configure this client to check whether the given element is enabled.
IAllowPuppeteerExecution	IsEndOfPage ()
	Configure this client to check whether the page is scrolled to its end.
IAllowPuppeteerExecution	IsVisibleInViewport (IGPALElement element)
	Configure this client to check whether the given element is visible in the viewport.
IAllowPuppeteerExecution	IsVisibleInViewport (string backendNodeId)
	Configure this client to check whether the element with the given backend node id is visible in the viewport.
IAllowPuppeteerParametersOrExecution	LeftClick (dynamic elementOrelementId)
	Configure this client to left-click the given element.
IAllowPuppeteerParametersOrExecution	MiddleClick (dynamic elementOrelementId)
	Configure this client to middle-click the given element.
IAllowPuppeteerParametersOrExecution	LeftDoubleClick (dynamic elementOrelementId)
	Configure this client to double left-click the given element.
IAllowPuppeteerParametersOrExecution	RightClick (dynamic elementOrelementId)
	Configure this client to right-click the given element.
IAllowPuppeteerSelectOptions	SelectClick (string elementHandle)
	Configure this client to open a select dropdown's options by clicking the element with the given handle; combine with WithSelectValue/WithSelectIndex to choose an option.
IAllowPuppeteerExecution	WithSelectValue (string value)
	Set the value to choose from the Select menu.
IAllowPuppeteerExecution	WithSelectIndex (int index)
	Sets the index of the option to choose from a Select menu.
IAllowPuppeteerExecution	ScrollIntoView (dynamic elementOrelementId)
	Configure this client to scroll the given element into view.
IAllowPuppeteerExecution	WindowInnerHeight ()
	Configure this client to retrieve the browser window's inner height.
IAllowPuppeteerExecution	WindowInnerWidth ()
	Configure this client to retrieve the browser window's inner width.
IAllowPuppeteerExecution	WindowOuterHeight ()
	Configure this client to retrieve the browser window's outer height.
IAllowPuppeteerExecution	WindowOuterWidth ()
	Configure this client to retrieve the browser window's outer width.
IAllowPuppeteerExecution	WindowPageOffsetX ()
	Configure this client to retrieve the page's horizontal scroll offset.
IAllowPuppeteerExecution	WindowPageOffsetY ()
	Configure this client to retrieve the page's vertical scroll offset.
IAllowPuppeteerExecution	WindowScreenLeft ()
	Configure this client to retrieve the browser window's screen X position.
IAllowPuppeteerExecution	WindowScreenTop ()
	Configure this client to retrieve the browser window's screen Y position.
IAllowPuppeteerExecution	Hover (string selector)
	Configure this client to hover the mouse over the given element.
IAllowPuppeteerExecution	MoveTo (System.Drawing.Point point)
	Configure this client to move the mouse to a viewport coordinate instead of to an element, for targets with no DOM handle such as an image match.
IAllowPuppeteerDragAndDrop	DragAndDrop (string selector)
	Configure this client to start a drag from the given element; combine with WithDestElementId or WithDeltaX/WithDeltaY to set the drop target.
IAllowPuppeteerExecution	QuerySelector (string css)
	Configure this client to find the first element matching the given CSS selector.
IAllowPuppeteerExecution	QuerySelectors (string css)
	Configure this client to find all elements matching the given CSS selector.
IAllowPuppeteerExecution	ScrollWindow (int hPixels, int vPixels)
	Configure this client to scroll the browser window by the given horizontal and vertical pixel amounts.
IAllowPuppeteerExecution	Evaluate (string xpath)
	Configure this client to evaluate the given XPath expression and return the first matching node.
IAllowPuppeteerExecution	EvaluateAll (string xpath)
	Configure this client to evaluate the given XPath expression and return all matching nodes.
IAllowPuppeteerExecution	ClearReferrer ()
	Configure this client to clear any overridden HTTP referrer.
IAllowPuppeteerAttribute	SetAttribute (string selector)
	Configure this client to set an attribute on the given element; combine with WithAttribute and WithValue to specify the attribute and value.
IAllowPuppeteerRangeValue	SetRange (string selector)
	Configure this client to set the value of a range input element; combine with WithRangeValue to specify the value.
IAllowPuppeteerExecution	WithRangeValue (int rangeValue)
	Sets the range value parameter for a SetRange request.
IAllowPuppeteerScrollElement	ScrollElement (string selector)
	Configure this client to scroll the given element; combine with WithHPixels/WithVPixels to specify the scroll amount.
IAllowPuppeteerExecution	ScrollElement (int hPixels, int vPixels)
	Configure this client to scroll the previously specified element by the given horizontal and vertical pixel amounts.
IAllowPuppeteerExecution	SetValueFrom (string destSelector)
	Sets the value of the destination element identified by destSelector from the source element identified by the preceding WithCss(string) or WithElementId(string) call. client.WithElementId("#source").SetValueFrom("#destination").Execute();.
IAllowPuppeteerExecution	TopBrowser ()
	Configure this client to bring the browser window to the foreground.
IAllowPuppeteerAttribute	GetAttribute (string selector)
	Configure this client to retrieve an attribute from the given element; combine with WithAttribute to specify which attribute.
IAllowPuppeteerStorageOptions	SetStorage (WebsiteStorageType storageType)
	Configure this client to write the given type of website storage; combine with WithStorageDomain/WithStorageKey/WithStorageData etc to specify what to write.
IAllowPuppeteerParametersOrExecution	UploadFrom (GPALFile fileToUpload)
	Sets the upload path parameter(s) so a subsequent action uploads the given file(s).
IAllowPuppeteerParametersOrExecution	LeftClickAndUpload (dynamic elementOrelementId)
	Configure this client to left-click the given element to open a file picker, then upload the file(s) set via UploadFrom.
Public Member Functions inherited from GenerallyPositive.Browser.IAllowPuppeteerParameters
IAllowPuppeteerParametersOrExecution	WithEncoding (Enums.ContentEncoding encoding)

Properties
string	Name `[get]`
	The display name assigned to this client via WithName.

Detailed Description

Definition at line 32 of file PupeteerClient.cs.

Member Function Documentation

◆ AndThen()

IPuppeteerClient GenerallyPositive.Browser.PuppeteerClient.AndThen ( )

Executes the configured request, then returns this client so further fluent calls can configure the next request.

Returns: Fluent interface to continue building the request

Implements GenerallyPositive.Browser.IAllowPuppeteerExecution.

Definition at line 2117 of file PupeteerClient.cs.

◆ AndThen< T >()

IPuppeteerClient GenerallyPositive.Browser.PuppeteerClient.AndThen< T > ( )

Implements GenerallyPositive.Browser.IAllowPuppeteerExecution.

Definition at line 2123 of file PupeteerClient.cs.

◆ Back()

IAllowPuppeteerExecution GenerallyPositive.Browser.PuppeteerClient.Back ( )

Configure this client to navigate the browser back one page in history.

Returns: Fluent interface to continue building the request

Implements GenerallyPositive.Browser.IAllowPuppeteerActions.

Definition at line 2634 of file PupeteerClient.cs.

◆ CaptureVisibleTab()

IAllowPuppeteerExecution GenerallyPositive.Browser.PuppeteerClient.CaptureVisibleTab ( ImageFormat imageFormat = ImageFormat::JPEG )

Configure this client to capture a screenshot of the visible tab in the given image format.

Parameters

imageFormat The image format to capture

Returns: Fluent interface to continue building the request

Implements GenerallyPositive.Browser.IAllowPuppeteerActions.

Definition at line 2645 of file PupeteerClient.cs.

◆ CastDesktop()

IAllowPuppeteerExecution GenerallyPositive.Browser.PuppeteerClient.CastDesktop ( string deviceNameOrId )

Cast the desktop to the specified device name client.CastDesktop("living room").Execute();.

Parameters

deviceNameOrId The Cast Device Name or ID

Returns

Implements GenerallyPositive.Browser.IAllowPuppeteerActions.

Definition at line 2657 of file PupeteerClient.cs.

◆ CastTab()

IAllowPuppeteerExecution GenerallyPositive.Browser.PuppeteerClient.CastTab ( string deviceNameOrId )

Cast the current tab to the specified device name client.CastTab("living room").Execute();.

Parameters

deviceNameOrId The Cast Device Name or ID

Returns

Implements GenerallyPositive.Browser.IAllowPuppeteerActions.

Definition at line 2668 of file PupeteerClient.cs.

◆ CheckNetworkIdle()

IAllowPuppeteerParametersOrExecution GenerallyPositive.Browser.PuppeteerClient.CheckNetworkIdle ( int maxConnections = 0 )

Configure this client to check whether network activity has gone idle.

Parameters

maxConnections Maximum number of in-flight connections still considered idle

Returns: Fluent interface to continue building the request

Implements GenerallyPositive.Browser.IAllowPuppeteerActions.

Definition at line 2930 of file PupeteerClient.cs.

◆ ClearInjectedScripts()

IAllowPuppeteerExecution GenerallyPositive.Browser.PuppeteerClient.ClearInjectedScripts ( )

Configure this client to remove all previously injected scripts (via InjectScript(string)).

Returns: Fluent interface to continue building the request

Implements GenerallyPositive.Browser.IAllowPuppeteerActions.

Definition at line 3527 of file PupeteerClient.cs.

◆ ClearReferrer()

IAllowPuppeteerExecution GenerallyPositive.Browser.PuppeteerClient.ClearReferrer ( )

Configure this client to clear any overridden HTTP referrer.

Returns: Fluent interface to continue building the request

Implements GenerallyPositive.Browser.IAllowPuppeteerActions.

Definition at line 4086 of file PupeteerClient.cs.

◆ ClearResults()

IAllowPuppeteerExecution GenerallyPositive.Browser.PuppeteerClient.ClearResults ( )

Empties what WithResultName has stored, so GetExecutionResults answers about what has happened since rather than everything since the client was made.

client.ClearResults();

Returns: Fluent interface to write your workflow

Implements GenerallyPositive.Browser.IAllowPuppeteerExecution.

Definition at line 2257 of file PupeteerClient.cs.

◆ ClearWorkflows()

IAllowPuppeteerWorkflow GenerallyPositive.Browser.PuppeteerClient.ClearWorkflows ( )

Returns a collection of all named results recorded so far across this client's executions.

Returns: Collection of execution results keyed by result name

Empties the workflow steps declared with WithWorkflow, so the next While or Until loop runs a new set rather than that one plus everything added before it. Steps otherwise stay on the client for as long as it lives, which is what lets the same set be run more than once.

client.ClearWorkflows().WithWorkflow(c => ...).While(() => ...);

Returns: Fluent interface to declare the next workflow

Implements GenerallyPositive.Browser.IAllowPuppeteerWorkflow.

Definition at line 2242 of file PupeteerClient.cs.

◆ CloseTab() [1/2]

IAllowPuppeteerExecution GenerallyPositive.Browser.PuppeteerClient.CloseTab ( GPALUrl url = null )

Configure this client to close the tab with the given URL, or the current tab if none is given.

Parameters

url	The URL of the tab to close, or null for the current tab

Returns: Fluent interface to continue building the request

Implements GenerallyPositive.Browser.IAllowPuppeteerActions.

Definition at line 2679 of file PupeteerClient.cs.

◆ CloseTab() [2/2]

IAllowPuppeteerExecution GenerallyPositive.Browser.PuppeteerClient.CloseTab ( int tabId )

Configure this client to close the tab with the given tab id.

Parameters

tabId The tab id to close

Returns: Fluent interface to continue building the request

Implements GenerallyPositive.Browser.IAllowPuppeteerActions.

Definition at line 2691 of file PupeteerClient.cs.

◆ CloseWindow() [1/2]

IAllowPuppeteerExecution GenerallyPositive.Browser.PuppeteerClient.CloseWindow ( GPALUrl url = null )

Configure this client to close the window containing the given URL, or the current window if none is given.

Parameters

url	The URL of the tab whose window should be closed, or null for the current window

Returns: Fluent interface to continue building the request

Implements GenerallyPositive.Browser.IAllowPuppeteerActions.

Definition at line 2703 of file PupeteerClient.cs.

◆ CloseWindow() [2/2]

IAllowPuppeteerExecution GenerallyPositive.Browser.PuppeteerClient.CloseWindow ( int tabId )

Configure this client to close the window containing the tab with the given tab id.

Parameters

tabId The tab id whose window should be closed

Returns: Fluent interface to continue building the request

Implements GenerallyPositive.Browser.IAllowPuppeteerActions.

Definition at line 2715 of file PupeteerClient.cs.

◆ DeleteStorage()

IAllowPuppeteerStorageOptions GenerallyPositive.Browser.PuppeteerClient.DeleteStorage ( WebsiteStorageType storageType )

Configure this client to delete the given type of website storage.

Parameters

storageType The type of storage to delete

Returns: Fluent interface to continue building the request

Implements GenerallyPositive.Browser.IAllowPuppeteerActions.

Definition at line 2727 of file PupeteerClient.cs.

◆ DownloadTo() [1/2]

IAllowPuppeteerParametersOrExecution GenerallyPositive.Browser.PuppeteerClient.DownloadTo ( GPALFile file )

Where a file the browser downloads should end up.
Not SaveTo, which is GPAL writing a file it already has. Only the directory of file reaches the browser, since CDP sets where a download lands and not what it is called; the download watcher gives it the name that was asked for.

Parameters

file	Where the downloaded file is to end up

Returns: Fluent interface to continue building the request

Implements GenerallyPositive.Browser.IAllowPuppeteerParametersOrExecution.

Definition at line 1975 of file PupeteerClient.cs.

◆ DownloadTo() [2/2]

IAllowPuppeteerExecution GenerallyPositive.Browser.PuppeteerClient.DownloadTo ( string downloadPath )

Where files the browser downloads should end up.
Not SaveTo, which is GPAL writing a file it already has. This sets the directory CDP sends downloads to.

Parameters

downloadPath Directory downloaded files are to end up in

Returns: Fluent interface to continue building the request

Implements GenerallyPositive.Browser.IAllowPuppeteerActions.

Definition at line 3539 of file PupeteerClient.cs.

◆ DragAndDrop()

IAllowPuppeteerDragAndDrop GenerallyPositive.Browser.PuppeteerClient.DragAndDrop ( string selector )

Configure this client to start a drag from the given element; combine with WithDestElementId or WithDeltaX/WithDeltaY to set the drop target.

Parameters

selector CSS selector of the element to drag

Returns: Fluent interface to continue building the request

Implements GenerallyPositive.Browser.IAllowPuppeteerActions.

Definition at line 4013 of file PupeteerClient.cs.

◆ Evaluate()

IAllowPuppeteerExecution GenerallyPositive.Browser.PuppeteerClient.Evaluate ( string xpath )

Configure this client to evaluate the given XPath expression and return the first matching node.

Parameters

xpath XPath expression

Returns: Fluent interface to continue building the request

Implements GenerallyPositive.Browser.IAllowPuppeteerActions.

Definition at line 4063 of file PupeteerClient.cs.

◆ EvaluateAll()

IAllowPuppeteerExecution GenerallyPositive.Browser.PuppeteerClient.EvaluateAll ( string xpath )

Configure this client to evaluate the given XPath expression and return all matching nodes.

Parameters

xpath XPath expression

Returns: Fluent interface to continue building the request

Implements GenerallyPositive.Browser.IAllowPuppeteerActions.

Definition at line 4075 of file PupeteerClient.cs.

◆ Execute()

string GenerallyPositive.Browser.PuppeteerClient.Execute ( )

Synchronously executes the configured request and returns the result as a string.

Returns: The result of the executed request

Implements GenerallyPositive.Browser.IAllowPuppeteerExecution.

Definition at line 2084 of file PupeteerClient.cs.

◆ Execute< T >()

T GenerallyPositive.Browser.PuppeteerClient.Execute< T > ( )

Implements GenerallyPositive.Browser.IAllowPuppeteerExecution.

Definition at line 2089 of file PupeteerClient.cs.

◆ ExecuteAsync()

async Task< string > GenerallyPositive.Browser.PuppeteerClient.ExecuteAsync ( )

Asynchronously executes the configured request and returns the result as a string.

Returns: Task that resolves to the result of the executed request

Implements GenerallyPositive.Browser.IAllowPuppeteerExecution.

Definition at line 2133 of file PupeteerClient.cs.

◆ ExecuteAsync< T >()

async Task< T > GenerallyPositive.Browser.PuppeteerClient.ExecuteAsync< T > ( )

Implements GenerallyPositive.Browser.IAllowPuppeteerExecution.

Definition at line 2144 of file PupeteerClient.cs.

◆ ExecuteJavaScript()

IAllowPuppeteerParameters GenerallyPositive.Browser.PuppeteerClient.ExecuteJavaScript ( string script )

Configure this client to execute the given JavaScript in the page.

Parameters

script The JavaScript to execute

Returns: Fluent interface to continue building the request

Implements GenerallyPositive.Browser.IAllowPuppeteerActions.

Definition at line 2740 of file PupeteerClient.cs.

◆ Fetch()

IAllowPuppeteerParametersOrExecution GenerallyPositive.Browser.PuppeteerClient.Fetch ( string url )

Configure this client to issue an API request from inside the page, so it carries the session the browser has already earned: its cookies, TLS fingerprint, header order and any anti-bot clearance.

Parameters

url	Url to request. A relative one resolves against wherever the browser currently is

Returns: Fluent interface to continue building the request

Implements GenerallyPositive.Browser.IAllowPuppeteerActions.

Definition at line 2753 of file PupeteerClient.cs.

◆ FillInAppend()

IAllowPuppeteerInputText GenerallyPositive.Browser.PuppeteerClient.FillInAppend	(	dynamic	elementOrelementId,
		int	delayMs = 0 )

Configure this client to append text to the given input element.

Parameters

elementOrelementId	A GPALElement, list of GPALElements, or element id identifying the input
delayMs	Inter-character pacing delay in milliseconds for the per-character key-event fallback. 0 uses the fallback's default pacing.

Returns: Fluent interface to continue building the request

Implements GenerallyPositive.Browser.IAllowPuppeteerActions.

Definition at line 2822 of file PupeteerClient.cs.

◆ FillInInsert()

IAllowPuppeteerInputText GenerallyPositive.Browser.PuppeteerClient.FillInInsert	(	dynamic	elementOrelementId,
		int	delayMs = 0 )

Configure this client to insert text at the start of the given input element.

Parameters

elementOrelementId	A GPALElement, list of GPALElements, or element id identifying the input
delayMs	Inter-character pacing delay in milliseconds for the per-character key-event fallback. 0 uses the fallback's default pacing.

Returns: Fluent interface to continue building the request

Implements GenerallyPositive.Browser.IAllowPuppeteerActions.

Definition at line 2843 of file PupeteerClient.cs.

◆ FillInOverwrite()

IAllowPuppeteerInputText GenerallyPositive.Browser.PuppeteerClient.FillInOverwrite	(	dynamic	elementOrelementId,
		int	delayMs = 0 )

Configure this client to overwrite the text of the given input element.

Parameters

elementOrelementId	A GPALElement, list of GPALElements, or element id identifying the input
delayMs	Inter-character pacing delay in milliseconds for the per-character key-event fallback. 0 uses the fallback's default pacing.

Returns: Fluent interface to continue building the request

Implements GenerallyPositive.Browser.IAllowPuppeteerActions.

Definition at line 2864 of file PupeteerClient.cs.

◆ FireChangeEvent()

IAllowPuppeteerExecution GenerallyPositive.Browser.PuppeteerClient.FireChangeEvent ( string selector )

Configure this client to fire a DOM change event on the given element.

Parameters

selector CSS selector of the element

Returns: Fluent interface to continue building the request

Implements GenerallyPositive.Browser.IAllowPuppeteerActions.

Definition at line 3552 of file PupeteerClient.cs.

◆ Focus()

IAllowPuppeteerExecution GenerallyPositive.Browser.PuppeteerClient.Focus ( string selector )

Configure this client to set keyboard focus on the given element.

Parameters

selector CSS selector of the element

Returns: Fluent interface to continue building the request

Implements GenerallyPositive.Browser.IAllowPuppeteerActions.

Definition at line 3564 of file PupeteerClient.cs.

◆ Forward()

IAllowPuppeteerExecution GenerallyPositive.Browser.PuppeteerClient.Forward ( )

Configure this client to navigate the browser forward one page in history.

Returns: Fluent interface to continue building the request

Implements GenerallyPositive.Browser.IAllowPuppeteerActions.

Definition at line 2883 of file PupeteerClient.cs.

◆ FullScreen()

IAllowPuppeteerExecution GenerallyPositive.Browser.PuppeteerClient.FullScreen ( )

Configure this client to make the browser window fullscreen.

Returns: Fluent interface to continue building the request

Implements GenerallyPositive.Browser.IAllowPuppeteerActions.

Definition at line 2893 of file PupeteerClient.cs.

◆ GetAttribute()

IAllowPuppeteerAttribute GenerallyPositive.Browser.PuppeteerClient.GetAttribute ( string selector )

Configure this client to retrieve an attribute from the given element; combine with WithAttribute to specify which attribute.

Parameters

selector CSS selector of the element

Returns: Fluent interface to continue building the request

Implements GenerallyPositive.Browser.IAllowPuppeteerActions.

Definition at line 4182 of file PupeteerClient.cs.

◆ GetBoundingClientRect()

IAllowPuppeteerExecution GenerallyPositive.Browser.PuppeteerClient.GetBoundingClientRect ( string backendNodeId )

Configure this client to retrieve the bounding client rectangle of the given element.

Parameters

backendNodeId Backend node id of the element

Returns: Fluent interface to continue building the request

Implements GenerallyPositive.Browser.IAllowPuppeteerActions.

Definition at line 3576 of file PupeteerClient.cs.

◆ GetContentAndCss()

IAllowPuppeteerExecution GenerallyPositive.Browser.PuppeteerClient.GetContentAndCss ( string selector )

Configure this client to retrieve the text content and computed CSS of the given element.

Parameters

selector CSS selector of the element

Returns: Fluent interface to continue building the request

Implements GenerallyPositive.Browser.IAllowPuppeteerActions.

Definition at line 3622 of file PupeteerClient.cs.

◆ GetCssAttributes()

IAllowPuppeteerExecution GenerallyPositive.Browser.PuppeteerClient.GetCssAttributes ( string selector )

Configure this client to retrieve the CSS attributes of the given element.

Parameters

selector CSS selector of the element

Returns: Fluent interface to continue building the request

Implements GenerallyPositive.Browser.IAllowPuppeteerActions.

Definition at line 3634 of file PupeteerClient.cs.

◆ GetCurrentUrl()

IAllowPuppeteerExecution GenerallyPositive.Browser.PuppeteerClient.GetCurrentUrl ( )

Configure this client to retrieve the current page URL.

Returns: Fluent interface to continue building the request

Implements GenerallyPositive.Browser.IAllowPuppeteerActions.

Definition at line 2953 of file PupeteerClient.cs.

◆ GetCurrentWindow()

IAllowPuppeteerExecution GenerallyPositive.Browser.PuppeteerClient.GetCurrentWindow ( )

Configure this client to retrieve information about the current browser window.

Returns: Fluent interface to continue building the request

Implements GenerallyPositive.Browser.IAllowPuppeteerActions.

Definition at line 2963 of file PupeteerClient.cs.

◆ GetDomAttributes()

IAllowPuppeteerExecution GenerallyPositive.Browser.PuppeteerClient.GetDomAttributes ( string selector )

Configure this client to retrieve the DOM attributes of the given element.

Parameters

selector CSS selector of the element

Returns: Fluent interface to continue building the request

Implements GenerallyPositive.Browser.IAllowPuppeteerActions.

Definition at line 3646 of file PupeteerClient.cs.

◆ GetDomProperties()

IAllowPuppeteerExecution GenerallyPositive.Browser.PuppeteerClient.GetDomProperties ( string selector )

Configure this client to retrieve the DOM properties of the given element.

Parameters

selector CSS selector of the element

Returns: Fluent interface to continue building the request

Implements GenerallyPositive.Browser.IAllowPuppeteerActions.

Definition at line 3658 of file PupeteerClient.cs.

◆ GetElementAttributeHash()

IAllowPuppeteerExecution GenerallyPositive.Browser.PuppeteerClient.GetElementAttributeHash ( string selector )

Configure this client to compute a hash of the given element's attributes, useful for detecting element changes.

Parameters

selector CSS selector of the element

Returns: Fluent interface to continue building the request

Implements GenerallyPositive.Browser.IAllowPuppeteerActions.

Definition at line 3588 of file PupeteerClient.cs.

◆ GetExecutionResults() [1/2]

ResultCollection GenerallyPositive.Browser.PuppeteerClient.GetExecutionResults ( )

Everything stored under a name so far, in the order it was stored. The target id a result was taken from is dropped here, since a caller asking by name is asking about the run rather than the tab.

Returns: The results, ready to be read by name or by position

Implements GenerallyPositive.Browser.IAllowPuppeteerExecution.

Definition at line 2268 of file PupeteerClient.cs.

◆ GetExecutionResults() [2/2]

IReadOnlyList< object > GenerallyPositive.Browser.PuppeteerClient.GetExecutionResults ( string name )

Every result stored under name , in the order it was stored, so a loop that ran five times answers with five. Ask without a name for the whole collection, or index it by name for the last answer alone.

int passes = client.GetExecutionResults("atBottom").Count;

Parameters

name	The name given to WithResultName

Returns: What was stored under that name

Implements GenerallyPositive.Browser.IAllowPuppeteerExecution.

Definition at line 2281 of file PupeteerClient.cs.

◆ GetLanguages()

IAllowPuppeteerExecution GenerallyPositive.Browser.PuppeteerClient.GetLanguages ( )

Configure this client to retrieve the browser's preferred languages, most preferred first.

Returns: Fluent interface to continue building the request

Implements GenerallyPositive.Browser.IAllowPuppeteerActions.

Definition at line 2986 of file PupeteerClient.cs.

◆ GetModifierBitmask()

int GenerallyPositive.Browser.PuppeteerClient.GetModifierBitmask ( ModifierKeys modifierKeys )

Converts GPAL ModifierKeys flags to the equivalent Chrome DevTools Protocol modifiers bitmask.

Parameters

modifierKeys The modifier keys to convert

Returns: The CDP modifiers bitmask

Definition at line 3335 of file PupeteerClient.cs.

◆ GetModifiersString()

string GenerallyPositive.Browser.PuppeteerClient.GetModifiersString ( int bitmask )

Converts a Chrome DevTools Protocol modifiers bitmask back to a human-readable, plus-separated list of modifier names.

Parameters

bitmask The CDP modifiers bitmask

Returns: The modifier names joined with "+", or "None" if no bits are set

Definition at line 3353 of file PupeteerClient.cs.

◆ GetPageSource()

IAllowPuppeteerExecution GenerallyPositive.Browser.PuppeteerClient.GetPageSource ( )

Configure this client to retrieve the current page's HTML source.

Returns: Fluent interface to continue building the request

Implements GenerallyPositive.Browser.IAllowPuppeteerActions.

Definition at line 3599 of file PupeteerClient.cs.

◆ GetParentNode()

IAllowPuppeteerExecution GenerallyPositive.Browser.PuppeteerClient.GetParentNode ( string selector )

Configure this client to retrieve the parent node of the given element.

Parameters

selector CSS selector of the element

Returns: Fluent interface to continue building the request

Implements GenerallyPositive.Browser.IAllowPuppeteerActions.

Definition at line 3610 of file PupeteerClient.cs.

◆ GetReadyStatus()

IAllowPuppeteerExecution GenerallyPositive.Browser.PuppeteerClient.GetReadyStatus ( )

Configure this client to query the puppeteer server's ready status, optionally for a specific session token.

Parameters

sessionToken Session token to check, or null for the default session

Returns: Fluent interface to continue building the request

Implements GenerallyPositive.Browser.IAllowPuppeteerActions.

Definition at line 2904 of file PupeteerClient.cs.

◆ GetShadowRoot()

IAllowPuppeteerExecution GenerallyPositive.Browser.PuppeteerClient.GetShadowRoot ( string css )

Configure this client to retrieve the shadow root of the element matching the given CSS selector.

Parameters

css	CSS selector of the element

Returns: Fluent interface to continue building the request

Implements GenerallyPositive.Browser.IAllowPuppeteerActions.

Definition at line 2942 of file PupeteerClient.cs.

◆ GetStorage()

IAllowPuppeteerStorageOptions GenerallyPositive.Browser.PuppeteerClient.GetStorage ( WebsiteStorageType storageType )

Configure this client to retrieve the given type of website storage.

Parameters

storageType The type of storage to retrieve

Returns: Fluent interface to continue building the request

Implements GenerallyPositive.Browser.IAllowPuppeteerActions.

Definition at line 2974 of file PupeteerClient.cs.

◆ GetUserAgent()

IAllowPuppeteerExecution GenerallyPositive.Browser.PuppeteerClient.GetUserAgent ( )

Configure this client to retrieve the browser's user agent string.

Returns: Fluent interface to continue building the request

Implements GenerallyPositive.Browser.IAllowPuppeteerActions.

Definition at line 2996 of file PupeteerClient.cs.

◆ GoTo()

IAllowPuppeteerExecution GenerallyPositive.Browser.PuppeteerClient.GoTo ( GPALUrl url )

Configure this client to navigate the current tab to the given URL, resolving relative URLs and checking robots.txt restrictions.

Parameters

url	The URL to navigate to

Returns: Fluent interface to continue building the request

Implements GenerallyPositive.Browser.IAllowPuppeteerActions.

Definition at line 3007 of file PupeteerClient.cs.

◆ GoToTab() [1/2]

IAllowPuppeteerExecution GenerallyPositive.Browser.PuppeteerClient.GoToTab ( GPALUrl url )

Configure this client to switch to the tab whose URL matches the given URL.

Parameters

url	The URL of the tab to switch to

Returns: Fluent interface to continue building the request

Implements GenerallyPositive.Browser.IAllowPuppeteerActions.

Definition at line 3026 of file PupeteerClient.cs.

◆ GoToTab() [2/2]

IAllowPuppeteerExecution GenerallyPositive.Browser.PuppeteerClient.GoToTab ( int tabId )

Configure this client to switch to the tab with the given tab id.

Parameters

tabId The tab id to switch to

Returns: Fluent interface to continue building the request

Implements GenerallyPositive.Browser.IAllowPuppeteerActions.

Definition at line 3038 of file PupeteerClient.cs.

◆ GoToWindow() [1/2]

IAllowPuppeteerExecution GenerallyPositive.Browser.PuppeteerClient.GoToWindow ( GPALUrl url )

Configure this client to switch to the window containing the tab whose URL matches the given URL.

Parameters

url	The URL of the tab whose window to switch to

Returns: Fluent interface to continue building the request

Implements GenerallyPositive.Browser.IAllowPuppeteerActions.

Definition at line 3050 of file PupeteerClient.cs.

◆ GoToWindow() [2/2]

IAllowPuppeteerExecution GenerallyPositive.Browser.PuppeteerClient.GoToWindow ( int tabId )

Configure this client to switch to the window containing the tab with the given tab id.

Parameters

tabId The tab id whose window to switch to

Returns: Fluent interface to continue building the request

Implements GenerallyPositive.Browser.IAllowPuppeteerActions.

Definition at line 3062 of file PupeteerClient.cs.

◆ HideElement()

IAllowPuppeteerExecution GenerallyPositive.Browser.PuppeteerClient.HideElement ( string selector )

Configure this client to hide the given element.

Parameters

selector CSS selector of the element

Returns: Fluent interface to continue building the request

Implements GenerallyPositive.Browser.IAllowPuppeteerActions.

Definition at line 3670 of file PupeteerClient.cs.

◆ Hover()

IAllowPuppeteerExecution GenerallyPositive.Browser.PuppeteerClient.Hover ( string selector )

Configure this client to hover the mouse over the given element.

Parameters

selector CSS selector of the element

Returns: Fluent interface to continue building the request

Implements GenerallyPositive.Browser.IAllowPuppeteerActions.

Definition at line 3971 of file PupeteerClient.cs.

◆ InElement()

IAllowPuppeteerExecution GenerallyPositive.Browser.PuppeteerClient.InElement ( string selector )

Configure this client to switch context into the element matching the given selector.

Parameters

selector CSS selector of the element

Returns: Fluent interface to continue building the request

Implements GenerallyPositive.Browser.IAllowPuppeteerActions.

Definition at line 3074 of file PupeteerClient.cs.

◆ InjectScript()

IAllowPuppeteerExecution GenerallyPositive.Browser.PuppeteerClient.InjectScript ( string script )

Configure this client to inject the given JavaScript into the page.

Parameters

script The JavaScript to inject

Returns: Fluent interface to continue building the request

Implements GenerallyPositive.Browser.IAllowPuppeteerActions.

Definition at line 3516 of file PupeteerClient.cs.

◆ InMainDom()

IAllowPuppeteerExecution GenerallyPositive.Browser.PuppeteerClient.InMainDom ( )

Configure this client to switch context back to the main document.

Returns: Fluent interface to continue building the request

Implements GenerallyPositive.Browser.IAllowPuppeteerActions.

Definition at line 3085 of file PupeteerClient.cs.

◆ InShadowDom()

IAllowPuppeteerExecution GenerallyPositive.Browser.PuppeteerClient.InShadowDom ( string selector )

Configure this client to switch context into the shadow root of the element matching the given selector.

Parameters

selector CSS selector of the element

Returns: Fluent interface to continue building the request

Implements GenerallyPositive.Browser.IAllowPuppeteerActions.

Definition at line 3096 of file PupeteerClient.cs.

◆ IsClickable()

IAllowPuppeteerExecution GenerallyPositive.Browser.PuppeteerClient.IsClickable ( string selector )

Configure this client to check whether the given element is clickable.

Parameters

selector CSS selector of the element

Returns: Fluent interface to continue building the request

Implements GenerallyPositive.Browser.IAllowPuppeteerActions.

Definition at line 3682 of file PupeteerClient.cs.

◆ IsDisplayed()

IAllowPuppeteerExecution GenerallyPositive.Browser.PuppeteerClient.IsDisplayed ( string selector )

Configure this client to check whether the given element is displayed.

Parameters

selector CSS selector of the element

Returns: Fluent interface to continue building the request

Implements GenerallyPositive.Browser.IAllowPuppeteerActions.

Definition at line 3694 of file PupeteerClient.cs.

◆ IsEnabled()

IAllowPuppeteerExecution GenerallyPositive.Browser.PuppeteerClient.IsEnabled ( string selector )

Configure this client to check whether the given element is enabled.

Parameters

selector CSS selector of the element

Returns: Fluent interface to continue building the request

Implements GenerallyPositive.Browser.IAllowPuppeteerActions.

Definition at line 3706 of file PupeteerClient.cs.

◆ IsEndOfPage()

IAllowPuppeteerExecution GenerallyPositive.Browser.PuppeteerClient.IsEndOfPage ( )

Configure this client to check whether the page is scrolled to its end.

Returns: Fluent interface to continue building the request

Implements GenerallyPositive.Browser.IAllowPuppeteerActions.

Definition at line 3717 of file PupeteerClient.cs.

◆ IsVisibleInViewport() [1/2]

IAllowPuppeteerExecution GenerallyPositive.Browser.PuppeteerClient.IsVisibleInViewport ( IGPALElement element )

Configure this client to check whether the given element is visible in the viewport.

Parameters

element The element to check

Returns: Fluent interface to continue building the request

Implements GenerallyPositive.Browser.IAllowPuppeteerActions.

Definition at line 3728 of file PupeteerClient.cs.

◆ IsVisibleInViewport() [2/2]

IAllowPuppeteerExecution GenerallyPositive.Browser.PuppeteerClient.IsVisibleInViewport ( string backendNodeId )

Configure this client to check whether the element with the given backend node id is visible in the viewport.

Parameters

backendNodeId Backend node id of the element

Returns: Fluent interface to continue building the request

Implements GenerallyPositive.Browser.IAllowPuppeteerActions.

Definition at line 3740 of file PupeteerClient.cs.

◆ LeftClick()

IAllowPuppeteerParametersOrExecution GenerallyPositive.Browser.PuppeteerClient.LeftClick ( dynamic elementOrelementId )

Configure this client to left-click the given element.

Parameters

elementOrelementId A GPALElement, list of GPALElements, element id, or a viewport Point for a target with no DOM handle

Returns: Fluent interface to continue building the request

Implements GenerallyPositive.Browser.IAllowPuppeteerActions.

Definition at line 3752 of file PupeteerClient.cs.

◆ LeftClickAndDownload()

IAllowPuppeteerParametersOrExecution GenerallyPositive.Browser.PuppeteerClient.LeftClickAndDownload ( string selector )

Configure this client to left-click the given element and download the resulting target.

Parameters

selector CSS selector of the element

Returns: Fluent interface to continue building the request

Implements GenerallyPositive.Browser.IAllowPuppeteerActions.

Definition at line 3383 of file PupeteerClient.cs.

◆ LeftClickAndUpload()

IAllowPuppeteerParametersOrExecution GenerallyPositive.Browser.PuppeteerClient.LeftClickAndUpload ( dynamic elementOrelementId )

Configure this client to left-click the given element to open a file picker, then upload the file(s) set via UploadFrom.

Parameters

elementOrelementId A GPALElement, list of GPALElements, or element id identifying the target

Returns: Fluent interface to continue building the request

Implements GenerallyPositive.Browser.IAllowPuppeteerActions.

Definition at line 4374 of file PupeteerClient.cs.

◆ LeftDoubleClick()

IAllowPuppeteerParametersOrExecution GenerallyPositive.Browser.PuppeteerClient.LeftDoubleClick ( dynamic elementOrelementId )

Configure this client to double left-click the given element.

Parameters

elementOrelementId A GPALElement, list of GPALElements, or element id identifying the target

Returns: Fluent interface to continue building the request

Implements GenerallyPositive.Browser.IAllowPuppeteerActions.

Definition at line 3796 of file PupeteerClient.cs.

◆ Maximize()

IAllowPuppeteerExecution GenerallyPositive.Browser.PuppeteerClient.Maximize ( )

Configure this client to maximize the browser window.

Returns: Fluent interface to continue building the request

Implements GenerallyPositive.Browser.IAllowPuppeteerActions.

Definition at line 3107 of file PupeteerClient.cs.

◆ MiddleClick()

IAllowPuppeteerParametersOrExecution GenerallyPositive.Browser.PuppeteerClient.MiddleClick ( dynamic elementOrelementId )

Configure this client to middle-click the given element.

Parameters

elementOrelementId A GPALElement, list of GPALElements, or element id identifying the target

Returns: Fluent interface to continue building the request

Implements GenerallyPositive.Browser.IAllowPuppeteerActions.

Definition at line 3774 of file PupeteerClient.cs.

◆ Minimize()

IAllowPuppeteerExecution GenerallyPositive.Browser.PuppeteerClient.Minimize ( )

Configure this client to minimize the browser window.

Returns: Fluent interface to continue building the request

Implements GenerallyPositive.Browser.IAllowPuppeteerActions.

Definition at line 3117 of file PupeteerClient.cs.

◆ MoveTo() [1/2]

IAllowPuppeteerExecution GenerallyPositive.Browser.PuppeteerClient.MoveTo ( string selector )

Configure this client to move the mouse to the element matching the given selector.

Parameters

selector CSS selector of the element

Returns: Fluent interface to continue building the request

Implements GenerallyPositive.Browser.IAllowPuppeteerActions.

Definition at line 3128 of file PupeteerClient.cs.

◆ MoveTo() [2/2]

IAllowPuppeteerExecution GenerallyPositive.Browser.PuppeteerClient.MoveTo ( System.Drawing.Point point )

Configure this client to move the mouse to a viewport coordinate instead of to an element, for targets with no DOM handle such as an image match.

Parameters

point Viewport coordinate, in CSS pixels

Returns: Fluent interface to continue building the request

Implements GenerallyPositive.Browser.IAllowPuppeteerActions.

Definition at line 4000 of file PupeteerClient.cs.

◆ NewTab()

IAllowPuppeteerExecution GenerallyPositive.Browser.PuppeteerClient.NewTab ( GPALUrl url = null )

Configure this client to open a new tab navigated to the given URL, resolving relative URLs and checking robots.txt restrictions.

Parameters

url	The URL to navigate to in the new tab, or null for a blank tab

Returns: Fluent interface to continue building the request

Implements GenerallyPositive.Browser.IAllowPuppeteerActions.

Definition at line 3140 of file PupeteerClient.cs.

◆ NextTab()

IAllowPuppeteerExecution GenerallyPositive.Browser.PuppeteerClient.NextTab ( )

Configure this client to switch to the next tab.

Returns: Fluent interface to continue building the request

Implements GenerallyPositive.Browser.IAllowPuppeteerActions.

Definition at line 3160 of file PupeteerClient.cs.

◆ NextWindow()

IAllowPuppeteerExecution GenerallyPositive.Browser.PuppeteerClient.NextWindow ( )

Configure this client to switch to the next browser window.

Returns: Fluent interface to continue building the request

Implements GenerallyPositive.Browser.IAllowPuppeteerActions.

Definition at line 3170 of file PupeteerClient.cs.

◆ Normal()

IAllowPuppeteerExecution GenerallyPositive.Browser.PuppeteerClient.Normal ( )

Configure this client to restore the browser window to its normal (non-maximized, non-minimized) state.

Returns: Fluent interface to continue building the request

Implements GenerallyPositive.Browser.IAllowPuppeteerActions.

Definition at line 3180 of file PupeteerClient.cs.

◆ OpenWindow()

IAllowPuppeteerExecution GenerallyPositive.Browser.PuppeteerClient.OpenWindow ( GPALUrl url )

Configure this client to open a new browser window navigated to the given URL, resolving relative URLs and checking robots.txt restrictions.

Parameters

url	The URL to navigate to in the new window

Returns: Fluent interface to continue building the request

Implements GenerallyPositive.Browser.IAllowPuppeteerActions.

Definition at line 3191 of file PupeteerClient.cs.

◆ OverrideReferrer()

IAllowPuppeteerExecution GenerallyPositive.Browser.PuppeteerClient.OverrideReferrer ( string referrer )

Configure this client to override the HTTP referrer sent with subsequent requests.

Parameters

referrer The referrer URL to send

Returns: Fluent interface to continue building the request

Implements GenerallyPositive.Browser.IAllowPuppeteerActions.

Definition at line 3212 of file PupeteerClient.cs.

◆ PageDown()

IAllowPuppeteerExecution GenerallyPositive.Browser.PuppeteerClient.PageDown ( int pagesToScroll = 1 )

Configure this client to scroll the page down by the given number of page heights.

Parameters

pagesToScroll Number of page heights to scroll down

Returns: Fluent interface to continue building the request

Implements GenerallyPositive.Browser.IAllowPuppeteerActions.

Definition at line 3236 of file PupeteerClient.cs.

◆ PageEnd()

IAllowPuppeteerExecution GenerallyPositive.Browser.PuppeteerClient.PageEnd ( )

Configure this client to scroll to the bottom of the page.

Returns: Fluent interface to continue building the request

Implements GenerallyPositive.Browser.IAllowPuppeteerActions.

Definition at line 3247 of file PupeteerClient.cs.

◆ PageTop()

IAllowPuppeteerExecution GenerallyPositive.Browser.PuppeteerClient.PageTop ( )

Configure this client to scroll to the top of the page.

Returns: Fluent interface to continue building the request

Implements GenerallyPositive.Browser.IAllowPuppeteerActions.

Definition at line 3257 of file PupeteerClient.cs.

◆ PageUp()

IAllowPuppeteerExecution GenerallyPositive.Browser.PuppeteerClient.PageUp ( int pagesToScroll = 1 )

Configure this client to scroll the page up by the given number of page heights.

Parameters

pagesToScroll Number of page heights to scroll up

Returns: Fluent interface to continue building the request

Implements GenerallyPositive.Browser.IAllowPuppeteerActions.

Definition at line 3268 of file PupeteerClient.cs.

◆ PressModifierKey()

IAllowPuppeteerExecution GenerallyPositive.Browser.PuppeteerClient.PressModifierKey ( ModifierKeys modifierKeys )

Configure this client to press and hold the given modifier key(s).

Parameters

modifierKeys Modifier key(s) to press and hold

Returns: Fluent interface to continue building the request

Implements GenerallyPositive.Browser.IAllowPuppeteerActions.

Definition at line 3310 of file PupeteerClient.cs.

◆ PreviousTab()

IAllowPuppeteerExecution GenerallyPositive.Browser.PuppeteerClient.PreviousTab ( )

Configure this client to switch to the previous tab.

Returns: Fluent interface to continue building the request

Implements GenerallyPositive.Browser.IAllowPuppeteerActions.

Definition at line 3279 of file PupeteerClient.cs.

◆ PreviousWindow()

IAllowPuppeteerExecution GenerallyPositive.Browser.PuppeteerClient.PreviousWindow ( )

Configure this client to switch to the previous browser window.

Returns: Fluent interface to continue building the request

Implements GenerallyPositive.Browser.IAllowPuppeteerActions.

Definition at line 3289 of file PupeteerClient.cs.

◆ QuerySelector()

IAllowPuppeteerExecution GenerallyPositive.Browser.PuppeteerClient.QuerySelector ( string css )

Configure this client to find the first element matching the given CSS selector.

Parameters

css	CSS selector

Returns: Fluent interface to continue building the request

Implements GenerallyPositive.Browser.IAllowPuppeteerActions.

Definition at line 4025 of file PupeteerClient.cs.

◆ QuerySelectors()

IAllowPuppeteerExecution GenerallyPositive.Browser.PuppeteerClient.QuerySelectors ( string css )

Configure this client to find all elements matching the given CSS selector.

Parameters

css	CSS selector

Returns: Fluent interface to continue building the request

Implements GenerallyPositive.Browser.IAllowPuppeteerActions.

Definition at line 4037 of file PupeteerClient.cs.

◆ Refresh()

IAllowPuppeteerExecution GenerallyPositive.Browser.PuppeteerClient.Refresh ( )

Configure this client to refresh the current page.

Returns: Fluent interface to continue building the request

Implements GenerallyPositive.Browser.IAllowPuppeteerActions.

Definition at line 3299 of file PupeteerClient.cs.

◆ ReleaseModifierKey()

IAllowPuppeteerExecution GenerallyPositive.Browser.PuppeteerClient.ReleaseModifierKey ( ModifierKeys modifierKeys )

Configure this client to release the given modifier key(s).

Parameters

modifierKeys Modifier key(s) to release

Returns: Fluent interface to continue building the request

Implements GenerallyPositive.Browser.IAllowPuppeteerActions.

Definition at line 3322 of file PupeteerClient.cs.

◆ Restore()

IAllowPuppeteerExecution GenerallyPositive.Browser.PuppeteerClient.Restore ( )

Configure this client to restore the browser window to its normal size.

Returns: Fluent interface to continue building the request

Implements GenerallyPositive.Browser.IAllowPuppeteerActions.

Definition at line 3372 of file PupeteerClient.cs.

◆ RightClick()

IAllowPuppeteerParametersOrExecution GenerallyPositive.Browser.PuppeteerClient.RightClick ( dynamic elementOrelementId )

Configure this client to right-click the given element.

Parameters

elementOrelementId A GPALElement, list of GPALElements, or element id identifying the target

Returns: Fluent interface to continue building the request

Implements GenerallyPositive.Browser.IAllowPuppeteerActions.

Definition at line 3818 of file PupeteerClient.cs.

◆ ScrollElement() [1/2]

IAllowPuppeteerExecution GenerallyPositive.Browser.PuppeteerClient.ScrollElement	(	int	hPixels,
		int	vPixels )

Configure this client to scroll the previously specified element by the given horizontal and vertical pixel amounts.

Parameters

hPixels	Horizontal pixels to scroll
vPixels	Vertical pixels to scroll

Returns: Fluent interface to continue building the request

Implements GenerallyPositive.Browser.IAllowPuppeteerActions.

Definition at line 4144 of file PupeteerClient.cs.

◆ ScrollElement() [2/2]

IAllowPuppeteerScrollElement GenerallyPositive.Browser.PuppeteerClient.ScrollElement ( string selector )

Configure this client to scroll the given element; combine with WithHPixels/WithVPixels to specify the scroll amount.

Parameters

selector CSS selector of the element to scroll

Returns: Fluent interface to continue building the request

Implements GenerallyPositive.Browser.IAllowPuppeteerActions.

Definition at line 4131 of file PupeteerClient.cs.

◆ ScrollIntoView()

IAllowPuppeteerExecution GenerallyPositive.Browser.PuppeteerClient.ScrollIntoView ( dynamic elementOrelementId )

Configure this client to scroll the given element into view.

Parameters

elementOrelementId A GPALElement, list of GPALElements, or element id identifying the target

Returns: Fluent interface to continue building the request

Implements GenerallyPositive.Browser.IAllowPuppeteerActions.

Definition at line 3872 of file PupeteerClient.cs.

◆ ScrollWindow()

IAllowPuppeteerExecution GenerallyPositive.Browser.PuppeteerClient.ScrollWindow	(	int	hPixels,
		int	vPixels )

Configure this client to scroll the browser window by the given horizontal and vertical pixel amounts.

Parameters

hPixels	Horizontal pixels to scroll
vPixels	Vertical pixels to scroll

Returns: Fluent interface to continue building the request

Implements GenerallyPositive.Browser.IAllowPuppeteerActions.

Definition at line 4050 of file PupeteerClient.cs.

◆ ScrollWindowByHorizontal()

IAllowPuppeteerExecution GenerallyPositive.Browser.PuppeteerClient.ScrollWindowByHorizontal ( int pixels )

Configure this client to scroll the browser window horizontally by the given number of pixels.

Parameters

pixels Number of pixels to scroll horizontally

Returns: Fluent interface to continue building the request

Implements GenerallyPositive.Browser.IAllowPuppeteerActions.

Definition at line 3395 of file PupeteerClient.cs.

◆ ScrollWindowByVertical()

IAllowPuppeteerExecution GenerallyPositive.Browser.PuppeteerClient.ScrollWindowByVertical ( int pixels )

Configure this client to scroll the browser window vertically by the given number of pixels.

Parameters

pixels Number of pixels to scroll vertically

Returns: Fluent interface to continue building the request

Implements GenerallyPositive.Browser.IAllowPuppeteerActions.

Definition at line 3407 of file PupeteerClient.cs.

◆ SelectClick()

IAllowPuppeteerSelectOptions GenerallyPositive.Browser.PuppeteerClient.SelectClick ( string elementHandle )

Configure this client to open a select dropdown's options by clicking the element with the given handle; combine with WithSelectValue/WithSelectIndex to choose an option.

Parameters

elementHandle Object id of the select element

Returns: Fluent interface to continue building the request

Implements GenerallyPositive.Browser.IAllowPuppeteerActions.

Definition at line 3840 of file PupeteerClient.cs.

◆ SendKey()

IAllowPuppeteerExecution GenerallyPositive.Browser.PuppeteerClient.SendKey ( byte vkcode )

Configure this client to send a key press for the given virtual key code, translating it to the corresponding DOM key and code.

Parameters

vkcode The virtual key code to send

Returns: Fluent interface to continue building the request

Implements GenerallyPositive.Browser.IAllowPuppeteerActions.

Definition at line 3433 of file PupeteerClient.cs.

◆ SendString()

IAllowPuppeteerExecution GenerallyPositive.Browser.PuppeteerClient.SendString	(	string	text,
		int	delayMs = 0 )

Configure this client to type the given text into the focused element.

Parameters

text	The text to type
delayMs	Inter-character pacing delay in milliseconds. 0 sends the whole string atomically; greater than 0 dispatches character-by-character with this delay between characters.

Returns: Fluent interface to continue building the request

Implements GenerallyPositive.Browser.IAllowPuppeteerActions.

Definition at line 3420 of file PupeteerClient.cs.

◆ SetAttribute()

IAllowPuppeteerAttribute GenerallyPositive.Browser.PuppeteerClient.SetAttribute ( string selector )

Configure this client to set an attribute on the given element; combine with WithAttribute and WithValue to specify the attribute and value.

Parameters

selector CSS selector of the element

Returns: Fluent interface to continue building the request

Implements GenerallyPositive.Browser.IAllowPuppeteerActions.

Definition at line 4097 of file PupeteerClient.cs.

◆ SetGoogleReferrer()

IAllowPuppeteerExecution GenerallyPositive.Browser.PuppeteerClient.SetGoogleReferrer ( )

Configure this client to override the HTTP referrer with https://www.google.com, to mimic arriving from a search engine.

Returns: Fluent interface to continue building the request

Implements GenerallyPositive.Browser.IAllowPuppeteerActions.

Definition at line 3449 of file PupeteerClient.cs.

◆ SetRange()

IAllowPuppeteerRangeValue GenerallyPositive.Browser.PuppeteerClient.SetRange ( string selector )

Configure this client to set the value of a range input element; combine with WithRangeValue to specify the value.

Parameters

selector CSS selector of the range element

Returns: Fluent interface to continue building the request

Implements GenerallyPositive.Browser.IAllowPuppeteerActions.

Definition at line 4109 of file PupeteerClient.cs.

◆ SetStorage()

IAllowPuppeteerStorageOptions GenerallyPositive.Browser.PuppeteerClient.SetStorage ( WebsiteStorageType storageType )

Configure this client to write the given type of website storage; combine with WithStorageDomain/WithStorageKey/WithStorageData etc to specify what to write.

Parameters

storageType The type of storage to write

Returns: Fluent interface to continue building the request

Implements GenerallyPositive.Browser.IAllowPuppeteerActions.

Definition at line 4227 of file PupeteerClient.cs.

◆ SetUserAgent()

IAllowPuppeteerExecution GenerallyPositive.Browser.PuppeteerClient.SetUserAgent ( string userAgent )

Configure this client to override the browser's user agent string for subsequent requests.

Parameters

userAgent The user agent string to use

Returns: Fluent interface to continue building the request

Implements GenerallyPositive.Browser.IAllowPuppeteerActions.

Definition at line 3224 of file PupeteerClient.cs.

◆ SetValueFrom()

IAllowPuppeteerExecution GenerallyPositive.Browser.PuppeteerClient.SetValueFrom ( string destSelector )

Sets the value of the destination element identified by destSelector from the source element identified by the preceding WithCss(string) or WithElementId(string) call. client.WithElementId("#source").SetValueFrom("#destination").Execute();.

Parameters

destSelector CSS selector identifying the destination element whose value is set

Returns: Fluent interface to continue building the request

Implements GenerallyPositive.Browser.IAllowPuppeteerParametersOrExecution.

Definition at line 4160 of file PupeteerClient.cs.

◆ StopCasting()

IAllowPuppeteerExecution GenerallyPositive.Browser.PuppeteerClient.StopCasting ( )

Configure this client to stop any active screen casting.

Returns: Fluent interface to continue building the request

Implements GenerallyPositive.Browser.IAllowPuppeteerActions.

Definition at line 3459 of file PupeteerClient.cs.

◆ SwitchToDefaultContent()

IAllowPuppeteerExecution GenerallyPositive.Browser.PuppeteerClient.SwitchToDefaultContent ( )

Configure this client to switch context back to the main document.

Returns: Fluent interface to continue building the request

Implements GenerallyPositive.Browser.IAllowPuppeteerActions.

Definition at line 3469 of file PupeteerClient.cs.

◆ SwitchToElement()

IAllowPuppeteerExecution GenerallyPositive.Browser.PuppeteerClient.SwitchToElement ( string selector )

Configure this client to switch context into the element matching the given selector.

Parameters

selector CSS selector of the element

Returns: Fluent interface to continue building the request

Implements GenerallyPositive.Browser.IAllowPuppeteerActions.

Definition at line 3480 of file PupeteerClient.cs.

◆ SwitchToFrame()

IAllowPuppeteerExecution GenerallyPositive.Browser.PuppeteerClient.SwitchToFrame ( string selector )

Configure this client to switch context into the iframe matching the given selector.

Parameters

selector CSS selector of the iframe element

Returns: Fluent interface to continue building the request

Implements GenerallyPositive.Browser.IAllowPuppeteerActions.

Definition at line 3492 of file PupeteerClient.cs.

◆ SwitchToShadowRoot()

IAllowPuppeteerExecution GenerallyPositive.Browser.PuppeteerClient.SwitchToShadowRoot ( string selector )

Configure this client to switch context into the shadow root of the element matching the given selector.

Parameters

selector CSS selector of the element

Returns: Fluent interface to continue building the request

Implements GenerallyPositive.Browser.IAllowPuppeteerActions.

Definition at line 3504 of file PupeteerClient.cs.

◆ ToGPALObject()

IPuppeteerClient GenerallyPositive.Browser.PuppeteerClient.ToGPALObject ( )

Returns this client cast to its public IPuppeteerClient interface.

Returns: This client as an IPuppeteerClient

Implements GenerallyPositive.Browser.IAllowToGPALObject< TResult >.

Definition at line 1468 of file PupeteerClient.cs.

◆ TopBrowser()

IAllowPuppeteerExecution GenerallyPositive.Browser.PuppeteerClient.TopBrowser ( )

Configure this client to bring the browser window to the foreground.

Returns: Fluent interface to continue building the request

Implements GenerallyPositive.Browser.IAllowPuppeteerActions.

Definition at line 4171 of file PupeteerClient.cs.

◆ Until()

IAllowPuppeteerParametersOrExecution GenerallyPositive.Browser.PuppeteerClient.Until ( Func< bool > condition )

Configures execution to repeat until the given condition returns true, subject to WhileLoopTimeout/WhileLoopMaxIterations.

Parameters

condition Predicate evaluated each iteration

Returns: Fluent interface to continue building the request

Implements GenerallyPositive.Browser.IAllowPuppeteerWorkflow.

Definition at line 2467 of file PupeteerClient.cs.

◆ UploadFrom()

IAllowPuppeteerParametersOrExecution GenerallyPositive.Browser.PuppeteerClient.UploadFrom ( GPALFile fileToUpload )

Sets the upload path parameter(s) so a subsequent action uploads the given file(s).

Parameters

fileToUpload The file(s) to upload

Returns: Fluent interface to continue building the request

Implements GenerallyPositive.Browser.IAllowPuppeteerParametersOrExecution.

Definition at line 4360 of file PupeteerClient.cs.

◆ While()

IAllowPuppeteerParametersOrExecution GenerallyPositive.Browser.PuppeteerClient.While ( Func< bool > condition )

Implements GenerallyPositive.Browser.IAllowPuppeteerWorkflow.

Definition at line 2455 of file PupeteerClient.cs.

◆ WhileLoopMaxIterations()

IAllowPuppeteerWorkflow GenerallyPositive.Browser.PuppeteerClient.WhileLoopMaxIterations ( int maxIterations )

Sets the maximum number of iterations a subsequent While/Until loop may run.

Parameters

maxIterations Maximum number of iterations

Returns: Fluent interface to continue building the request

Implements GenerallyPositive.Browser.IAllowPuppeteerWorkflow.

Definition at line 2384 of file PupeteerClient.cs.

◆ WhileLoopTimeout()

IAllowPuppeteerWorkflow GenerallyPositive.Browser.PuppeteerClient.WhileLoopTimeout ( int timeoutMs )

Sets the maximum time a subsequent While/Until loop may run before timing out.

Parameters

timeoutMs Timeout in milliseconds

Returns: Fluent interface to continue building the request

Implements GenerallyPositive.Browser.IAllowPuppeteerWorkflow.

Definition at line 2373 of file PupeteerClient.cs.

◆ WindowInnerHeight()

IAllowPuppeteerExecution GenerallyPositive.Browser.PuppeteerClient.WindowInnerHeight ( )

Configure this client to retrieve the browser window's inner height.

Returns: Fluent interface to continue building the request

Implements GenerallyPositive.Browser.IAllowPuppeteerActions.

Definition at line 3890 of file PupeteerClient.cs.

◆ WindowInnerWidth()

IAllowPuppeteerExecution GenerallyPositive.Browser.PuppeteerClient.WindowInnerWidth ( )

Configure this client to retrieve the browser window's inner width.

Returns: Fluent interface to continue building the request

Implements GenerallyPositive.Browser.IAllowPuppeteerActions.

Definition at line 3900 of file PupeteerClient.cs.

◆ WindowOuterHeight()

IAllowPuppeteerExecution GenerallyPositive.Browser.PuppeteerClient.WindowOuterHeight ( )

Configure this client to retrieve the browser window's outer height.

Returns: Fluent interface to continue building the request

Implements GenerallyPositive.Browser.IAllowPuppeteerActions.

Definition at line 3910 of file PupeteerClient.cs.

◆ WindowOuterWidth()

IAllowPuppeteerExecution GenerallyPositive.Browser.PuppeteerClient.WindowOuterWidth ( )

Configure this client to retrieve the browser window's outer width.

Returns: Fluent interface to continue building the request

Implements GenerallyPositive.Browser.IAllowPuppeteerActions.

Definition at line 3920 of file PupeteerClient.cs.

◆ WindowPageOffsetX()

IAllowPuppeteerExecution GenerallyPositive.Browser.PuppeteerClient.WindowPageOffsetX ( )

Configure this client to retrieve the page's horizontal scroll offset.

Returns: Fluent interface to continue building the request

Implements GenerallyPositive.Browser.IAllowPuppeteerActions.

Definition at line 3930 of file PupeteerClient.cs.

◆ WindowPageOffsetY()

IAllowPuppeteerExecution GenerallyPositive.Browser.PuppeteerClient.WindowPageOffsetY ( )

Configure this client to retrieve the page's vertical scroll offset.

Returns: Fluent interface to continue building the request

Implements GenerallyPositive.Browser.IAllowPuppeteerActions.

Definition at line 3940 of file PupeteerClient.cs.

◆ WindowScreenLeft()

IAllowPuppeteerExecution GenerallyPositive.Browser.PuppeteerClient.WindowScreenLeft ( )

Configure this client to retrieve the browser window's screen X position.

Returns: Fluent interface to continue building the request

Implements GenerallyPositive.Browser.IAllowPuppeteerActions.

Definition at line 3950 of file PupeteerClient.cs.

◆ WindowScreenTop()

IAllowPuppeteerExecution GenerallyPositive.Browser.PuppeteerClient.WindowScreenTop ( )

Configure this client to retrieve the browser window's screen Y position.

Returns: Fluent interface to continue building the request

Implements GenerallyPositive.Browser.IAllowPuppeteerActions.

Definition at line 3960 of file PupeteerClient.cs.

◆ WithAttribute()

IAllowPuppeteerAttribute GenerallyPositive.Browser.PuppeteerClient.WithAttribute ( string attribute )

Sets the attribute name parameter for SetAttribute/GetAttribute requests.

Parameters

attribute The attribute name

Returns: Fluent interface to continue building the request

Implements GenerallyPositive.Browser.IAllowPuppeteerAttribute.

Definition at line 2589 of file PupeteerClient.cs.

◆ WithBody()

IAllowPuppeteerParametersOrExecution GenerallyPositive.Browser.PuppeteerClient.WithBody ( string body )

Body to send with the request.

Parameters

body	Request body

Returns: Fluent interface to continue building the request

Implements GenerallyPositive.Browser.IAllowPuppeteerActions.

Definition at line 2776 of file PupeteerClient.cs.

◆ WithBytes()

IAllowPuppeteerParametersOrExecution GenerallyPositive.Browser.PuppeteerClient.WithBytes ( bool asBytes )

True to bring the response body back base64 encoded, which is what a file needs. Text is the default, and reading a file as text would put a replacement character wherever a byte is not valid utf-8.

Parameters

asBytes True for a base64 encoded body, false for text

Returns: Fluent interface to continue building the request

Implements GenerallyPositive.Browser.IAllowPuppeteerActions.

Definition at line 2810 of file PupeteerClient.cs.

◆ WithContentType()

IAllowPuppeteerParametersOrExecution GenerallyPositive.Browser.PuppeteerClient.WithContentType ( string contentType )

Content type of the body.

Parameters

contentType Content type

Returns: Fluent interface to continue building the request

Implements GenerallyPositive.Browser.IAllowPuppeteerActions.

Definition at line 2787 of file PupeteerClient.cs.

◆ WithCss()

IAllowPuppeteerParametersOrExecution GenerallyPositive.Browser.PuppeteerClient.WithCss ( string css )

Sets the css selector parameter for the request.

Parameters

css	CSS selector

Returns: Fluent interface to continue building the request

Implements GenerallyPositive.Browser.IAllowPuppeteerParametersOrExecution.

Definition at line 1764 of file PupeteerClient.cs.

◆ WithCssFromResult() [1/2]

IAllowPuppeteerParametersOrExecution GenerallyPositive.Browser.PuppeteerClient.WithCssFromResult ( int resultIndex )

Sets the css selector parameter from the result at the given index of a previous execution.

Parameters

resultIndex Index into the execution results

Returns: Fluent interface to continue building the request

Implements GenerallyPositive.Browser.IAllowPuppeteerParametersOrExecution.

Definition at line 1775 of file PupeteerClient.cs.

◆ WithCssFromResult() [2/2]

IAllowPuppeteerParametersOrExecution GenerallyPositive.Browser.PuppeteerClient.WithCssFromResult ( string name )

Sets the css selector parameter from the named result of a previous execution.

Parameters

name	Name of a previous execution result

Returns: Fluent interface to continue building the request

Implements GenerallyPositive.Browser.IAllowPuppeteerParametersOrExecution.

Definition at line 1786 of file PupeteerClient.cs.

◆ WithDeleteAcrossOrigins()

IAllowPuppeteerStorageOptions GenerallyPositive.Browser.PuppeteerClient.WithDeleteAcrossOrigins ( bool trueOrFalse )

Sets whether storage should be deleted across all origins, not just the current one.

Parameters

trueOrFalse True to delete storage across all origins

Returns: Fluent interface to continue building the request

Implements GenerallyPositive.Browser.IAllowPuppeteerStorageOptions.

Definition at line 1721 of file PupeteerClient.cs.

◆ WithDeltaX()

IAllowPuppeteerDragAndDrop GenerallyPositive.Browser.PuppeteerClient.WithDeltaX ( int deltaX )

Sets the horizontal drag delta parameter for a drag and drop.

Parameters

deltaX Horizontal drag distance, in pixels

Returns: Fluent interface to continue building the request

Implements GenerallyPositive.Browser.IAllowPuppeteerDragAndDrop.

Definition at line 2545 of file PupeteerClient.cs.

◆ WithDeltaY()

IAllowPuppeteerDragAndDrop GenerallyPositive.Browser.PuppeteerClient.WithDeltaY ( int deltaY )

Sets the vertical drag delta parameter for a drag and drop.

Parameters

deltaY Vertical drag distance, in pixels

Returns: Fluent interface to continue building the request

Implements GenerallyPositive.Browser.IAllowPuppeteerDragAndDrop.

Definition at line 2556 of file PupeteerClient.cs.

◆ WithDestElementId()

IAllowPuppeteerExecution GenerallyPositive.Browser.PuppeteerClient.WithDestElementId ( string destElementId )

Sets the destination element id parameter for a drag and drop.

Parameters

destElementId Element id of the drop target

Returns: Fluent interface to continue building the request

Definition at line 2613 of file PupeteerClient.cs.

◆ WithDeviceName()

IAllowPuppeteerExecution GenerallyPositive.Browser.PuppeteerClient.WithDeviceName ( string sinkName )

Sets the CSS parameter.

Parameters

css	The CSS selector

Returns

Implements GenerallyPositive.Browser.IAllowPuppeteerParametersOrExecution.

Definition at line 2624 of file PupeteerClient.cs.

◆ WithElementFromResult() [1/2]

IAllowPuppeteerParametersOrExecution GenerallyPositive.Browser.PuppeteerClient.WithElementFromResult ( int resultIndex )

Sets the elementId parameter from the result at the given index of a previous execution, then calls WithElementId.

Parameters

resultIndex Index into the execution results

Returns: Fluent interface to continue building the request

Implements GenerallyPositive.Browser.IAllowPuppeteerParametersOrExecution.

Definition at line 1808 of file PupeteerClient.cs.

◆ WithElementFromResult() [2/2]

IAllowPuppeteerParametersOrExecution GenerallyPositive.Browser.PuppeteerClient.WithElementFromResult ( string name )

Sets the elementId parameter from the named result of a previous execution, then calls WithElementId.

Parameters

name	Name of a previous execution result

Returns: Fluent interface to continue building the request

Implements GenerallyPositive.Browser.IAllowPuppeteerParametersOrExecution.

Definition at line 1819 of file PupeteerClient.cs.

◆ WithElementId()

IAllowPuppeteerParametersOrExecution GenerallyPositive.Browser.PuppeteerClient.WithElementId ( string selector )

Sets the elementId parameter for the request, resolving CSS selectors to an element handle if needed.

Parameters

selector An element id/object id, or a CSS selector to resolve

Returns: Fluent interface to continue building the request

Implements GenerallyPositive.Browser.IAllowPuppeteerParametersOrExecution.

Definition at line 1994 of file PupeteerClient.cs.

◆ WithElementIdFromResult() [1/2]

IAllowPuppeteerParametersOrExecution GenerallyPositive.Browser.PuppeteerClient.WithElementIdFromResult ( int resultIndex )

Sets the elementId parameter from the result at the given index of a previous execution, then calls WithElementId.

Parameters

resultIndex Index into the execution results

Returns: Fluent interface to continue building the request

Implements GenerallyPositive.Browser.IAllowPuppeteerParametersOrExecution.

Definition at line 2015 of file PupeteerClient.cs.

◆ WithElementIdFromResult() [2/2]

IAllowPuppeteerParametersOrExecution GenerallyPositive.Browser.PuppeteerClient.WithElementIdFromResult ( string name )

Sets the elementId parameter from the named result of a previous execution, then calls WithElementId.

Parameters

name	Name of a previous execution result

Returns: Fluent interface to continue building the request

Implements GenerallyPositive.Browser.IAllowPuppeteerParametersOrExecution.

Definition at line 2026 of file PupeteerClient.cs.

◆ WithElements()

IAllowPuppeteerParametersOrExecution GenerallyPositive.Browser.PuppeteerClient.WithElements ( List< GPALElement > gpalElements )

Sets the gpalElements parameter, identifying the elements the request should act on.

Parameters

gpalElements The elements to act on

Returns: Fluent interface to continue building the request

Implements GenerallyPositive.Browser.IAllowPuppeteerParametersOrExecution.

Definition at line 1797 of file PupeteerClient.cs.

◆ WithEncoding()

IAllowPuppeteerParametersOrExecution GenerallyPositive.Browser.PuppeteerClient.WithEncoding ( ContentEncoding encoding )

Sets the content encoding used for requests sent to the puppeteer communicator.

Parameters

encoding The content encoding to use

Returns: Fluent interface to continue building the request

Definition at line 2347 of file PupeteerClient.cs.

◆ WithEndpoint() [1/2]

IAllowPuppeteerParametersOrExecution GenerallyPositive.Browser.PuppeteerClient.WithEndpoint ( ApiEndpoint endpoint )

Sets the endpoint to call, resolved from the given ApiEndpoint value. Parameters set before this call survive it, so the endpoint and its parameters can be named in either order.

Parameters

endpoint The API endpoint to call

Returns: Fluent interface to continue building the request

Implements GenerallyPositive.Browser.IAllowPuppeteerEndpointDetails.

Definition at line 1510 of file PupeteerClient.cs.

◆ WithEndpoint() [2/2]

IAllowPuppeteerParametersOrExecution GenerallyPositive.Browser.PuppeteerClient.WithEndpoint ( string endpoint )

Sets a custom endpoint path to call directly, bypassing the built-in ApiEndpoint enum.

Parameters

endpoint The endpoint path to call

Returns: Fluent interface to continue building the request

Implements GenerallyPositive.Browser.IAllowPuppeteerEndpointDetails.

Definition at line 1497 of file PupeteerClient.cs.

◆ WithHeader()

IAllowPuppeteerExecution GenerallyPositive.Browser.PuppeteerClient.WithHeader	(	string	name,
		string	value )

Sets an extra HTTP header to send with the request.

Parameters

name	Header name
value	Header value

Returns: Fluent interface to continue building the request

Implements GenerallyPositive.Browser.IAllowPuppeteerExecution.

Definition at line 2292 of file PupeteerClient.cs.

◆ WithHeaders()

IAllowPuppeteerParametersOrExecution GenerallyPositive.Browser.PuppeteerClient.WithHeaders ( string[] headers )

Extra request headers, flattened to name, value, name, value.

Parameters

headers Header names and values in pairs

Returns: Fluent interface to continue building the request

Implements GenerallyPositive.Browser.IAllowPuppeteerActions.

Definition at line 2798 of file PupeteerClient.cs.

◆ WithHPixels()

IAllowPuppeteerScrollElement GenerallyPositive.Browser.PuppeteerClient.WithHPixels ( int hPixels )

Sets the horizontal pixels parameter for the request.

Parameters

hPixels Number of horizontal pixels

Returns: Fluent interface to continue building the request

Implements GenerallyPositive.Browser.IAllowPuppeteerScrollElement.

Definition at line 2523 of file PupeteerClient.cs.

◆ WithHPixelsFromResult() [1/2]

IAllowPuppeteerParametersOrExecution GenerallyPositive.Browser.PuppeteerClient.WithHPixelsFromResult ( int resultIndex )

Sets the horizontal pixels parameter from the result at the given index of a previous execution.

Parameters

resultIndex Index into the execution results

Returns: Fluent interface to continue building the request

Implements GenerallyPositive.Browser.IAllowPuppeteerParametersOrExecution.

Definition at line 2037 of file PupeteerClient.cs.

◆ WithHPixelsFromResult() [2/2]

IAllowPuppeteerParametersOrExecution GenerallyPositive.Browser.PuppeteerClient.WithHPixelsFromResult ( string name )

Sets the horizontal pixels parameter from the named result of a previous execution.

Parameters

name	Name of a previous execution result

Returns: Fluent interface to continue building the request

Implements GenerallyPositive.Browser.IAllowPuppeteerParametersOrExecution.

Definition at line 2049 of file PupeteerClient.cs.

◆ WithIteration()

IAllowPuppeteerParametersOrExecution GenerallyPositive.Browser.PuppeteerClient.WithIteration ( int iteration )

Sets the iteration for an endpoint to retrieve from the results when using WithXXXFromResults.

Parameters

iteration

Returns

Definition at line 1829 of file PupeteerClient.cs.

◆ WithKey()

IAllowPuppeteerParametersOrExecution GenerallyPositive.Browser.PuppeteerClient.WithKey ( string key )

Sets the key parameter for the request.

Parameters

key The key

Returns: Fluent interface to continue building the request

Implements GenerallyPositive.Browser.IAllowPuppeteerParametersOrExecution.

Definition at line 1731 of file PupeteerClient.cs.

◆ WithKeyFromResult() [1/2]

IAllowPuppeteerParametersOrExecution GenerallyPositive.Browser.PuppeteerClient.WithKeyFromResult ( int resultIndex )

Sets the key parameter from the result at the given index of a previous execution.

Parameters

resultIndex Index into the execution results

Returns: Fluent interface to continue building the request

Implements GenerallyPositive.Browser.IAllowPuppeteerParametersOrExecution.

Definition at line 1742 of file PupeteerClient.cs.

◆ WithKeyFromResult() [2/2]

IAllowPuppeteerParametersOrExecution GenerallyPositive.Browser.PuppeteerClient.WithKeyFromResult ( string name )

Sets the key parameter from the named result of a previous execution.

Parameters

name	Name of a previous execution result

Returns: Fluent interface to continue building the request

Implements GenerallyPositive.Browser.IAllowPuppeteerParametersOrExecution.

Definition at line 1753 of file PupeteerClient.cs.

◆ WithMaxConnections()

IAllowPuppeteerCheckNetworkIdleOrExecution GenerallyPositive.Browser.PuppeteerClient.WithMaxConnections ( int maxConnections )

Sets the maximum number of in-flight connections allowed before the network is considered busy, used by CheckNetworkIdle.

Parameters

maxConnections Maximum number of in-flight connections

Returns: Fluent interface to continue building the request

Implements GenerallyPositive.Browser.IAllowPuppeteerCheckNetworkIdleOrExecution.

Definition at line 2501 of file PupeteerClient.cs.

◆ WithModifiers()

IAllowPuppeteerParametersOrExecution GenerallyPositive.Browser.PuppeteerClient.WithModifiers ( ModifierKeys modifierKeys )

Sets the modifier keys parameter for the request.

Parameters

modifierKeys Modifier keys to hold during the action

Returns: Fluent interface to continue building the request

Implements GenerallyPositive.Browser.IAllowPuppeteerParametersOrExecution.

Definition at line 2512 of file PupeteerClient.cs.

◆ WithName()

IAllowPuppeteerEndpointDetails GenerallyPositive.Browser.PuppeteerClient.WithName ( string name )

Sets the display name for this client.

Parameters

name	The name to assign

Returns: Fluent interface to continue building the request

Implements GenerallyPositive.Browser.IAllowPuppeteerEndpointDetails.

Definition at line 1550 of file PupeteerClient.cs.

◆ WithOffsetX()

IAllowPuppeteerDragAndDrop GenerallyPositive.Browser.PuppeteerClient.WithOffsetX ( int offsetX )

Sets the horizontal grab offset within the element for a drag and drop.

Parameters

offsetX Horizontal grab offset, in pixels, within the element

Returns: Fluent interface to continue building the request

Implements GenerallyPositive.Browser.IAllowPuppeteerDragAndDrop.

Definition at line 2567 of file PupeteerClient.cs.

◆ WithOffsetY()

IAllowPuppeteerDragAndDrop GenerallyPositive.Browser.PuppeteerClient.WithOffsetY ( int offsetY )

Sets the vertical grab offset within the element for a drag and drop.

Parameters

offsetY Vertical grab offset, in pixels, within the element

Returns: Fluent interface to continue building the request

Implements GenerallyPositive.Browser.IAllowPuppeteerDragAndDrop.

Definition at line 2578 of file PupeteerClient.cs.

◆ WithParameters() [1/2]

IAllowPuppeteerParametersOrExecution GenerallyPositive.Browser.PuppeteerClient.WithParameters ( object parameters )

Sets the request parameters from an object with named fields.

Parameters

parameters Object whose properties are the named parameters

Returns: Fluent interface to continue building the request

Implements GenerallyPositive.Browser.IAllowPuppeteerParameters.

Definition at line 2314 of file PupeteerClient.cs.

◆ WithParameters() [2/2]

IAllowPuppeteerParametersOrExecution GenerallyPositive.Browser.PuppeteerClient.WithParameters ( params object[] parameters )

Sets the request parameters as an ordinal array.

Parameters

parameters Ordinal parameter values

Returns: Fluent interface to continue building the request

Implements GenerallyPositive.Browser.IAllowPuppeteerParameters.

Definition at line 2303 of file PupeteerClient.cs.

◆ WithParametersFromResult() [1/2]

IAllowPuppeteerParametersOrExecution GenerallyPositive.Browser.PuppeteerClient.WithParametersFromResult ( int resultIndex )

Sets the request parameters from the result at the given index of a previous execution.

Parameters

resultIndex Index into the execution results

Returns: Fluent interface to continue building the request

Implements GenerallyPositive.Browser.IAllowPuppeteerParameters.

Definition at line 2325 of file PupeteerClient.cs.

◆ WithParametersFromResult() [2/2]

IAllowPuppeteerParametersOrExecution GenerallyPositive.Browser.PuppeteerClient.WithParametersFromResult ( string name )

Sets the request parameters from the named result of a previous execution.

Parameters

name	Name of a previous execution result

Returns: Fluent interface to continue building the request

Implements GenerallyPositive.Browser.IAllowPuppeteerParameters.

Definition at line 2336 of file PupeteerClient.cs.

◆ WithPixels()

IAllowPuppeteerParametersOrExecution GenerallyPositive.Browser.PuppeteerClient.WithPixels ( int pixels )

Sets the pixels parameter for the request.

Parameters

pixels Number of pixels

Returns: Fluent interface to continue building the request

Implements GenerallyPositive.Browser.IAllowPuppeteerParametersOrExecution.

Definition at line 1872 of file PupeteerClient.cs.

◆ WithPixelsFromResult() [1/2]

IAllowPuppeteerParametersOrExecution GenerallyPositive.Browser.PuppeteerClient.WithPixelsFromResult ( int resultIndex )

Sets the pixels parameter from the result at the given index of a previous execution.

Parameters

resultIndex Index into the execution results

Returns: Fluent interface to continue building the request

Implements GenerallyPositive.Browser.IAllowPuppeteerParametersOrExecution.

Definition at line 1883 of file PupeteerClient.cs.

◆ WithPixelsFromResult() [2/2]

IAllowPuppeteerParametersOrExecution GenerallyPositive.Browser.PuppeteerClient.WithPixelsFromResult ( string name )

Sets the pixels parameter from the named result of a previous execution.

Parameters

name	Name of a previous execution result

Returns: Fluent interface to continue building the request

Implements GenerallyPositive.Browser.IAllowPuppeteerParametersOrExecution.

Definition at line 1894 of file PupeteerClient.cs.

◆ WithPruneMs()

IAllowPuppeteerCheckNetworkIdleOrExecution GenerallyPositive.Browser.PuppeteerClient.WithPruneMs ( int pruneMs )

Sets the prune interval, in milliseconds, used by CheckNetworkIdle.

Parameters

pruneMs Prune interval in milliseconds

Returns: Fluent interface to continue building the request

Implements GenerallyPositive.Browser.IAllowPuppeteerCheckNetworkIdleOrExecution.

Definition at line 2490 of file PupeteerClient.cs.

◆ WithPuppeteerCommunicator()

IAllowPuppeteerEndpointDetails GenerallyPositive.Browser.PuppeteerClient.WithPuppeteerCommunicator ( PuppeteerCommunicator communicator )

Sets the PuppeteerCommunicator used to send commands to the puppeteer/CDP server.

Parameters

communicator The communicator to use for this client

Returns: Fluent interface to continue building the request

Implements GenerallyPositive.Browser.IAllowPuppeteerCommunicator.

Definition at line 1486 of file PupeteerClient.cs.

◆ WithRangeValue()

IAllowPuppeteerExecution GenerallyPositive.Browser.PuppeteerClient.WithRangeValue ( int rangeValue )

Sets the range value parameter for a SetRange request.

Parameters

rangeValue The value to set on the range input

Returns: Fluent interface to continue building the request

Implements GenerallyPositive.Browser.IAllowPuppeteerRangeValue.

Definition at line 4121 of file PupeteerClient.cs.

◆ WithReferrer()

IAllowPuppeteerParametersOrExecution GenerallyPositive.Browser.PuppeteerClient.WithReferrer ( string referrer )

Sets the referrer parameter for the request.

Parameters

referrer The referrer URL

Returns: Fluent interface to continue building the request

Implements GenerallyPositive.Browser.IAllowPuppeteerParametersOrExecution.

Definition at line 1905 of file PupeteerClient.cs.

◆ WithReferrerFromResult() [1/2]

IAllowPuppeteerParametersOrExecution GenerallyPositive.Browser.PuppeteerClient.WithReferrerFromResult ( int resultIndex )

Sets the referrer parameter from the result at the given index of a previous execution.

Parameters

resultIndex Index into the execution results

Returns: Fluent interface to continue building the request

Implements GenerallyPositive.Browser.IAllowPuppeteerParametersOrExecution.

Definition at line 1916 of file PupeteerClient.cs.

◆ WithReferrerFromResult() [2/2]

IAllowPuppeteerParametersOrExecution GenerallyPositive.Browser.PuppeteerClient.WithReferrerFromResult ( string name )

Sets the referrer parameter from the named result of a previous execution.

Parameters

name	Name of a previous execution result

Returns: Fluent interface to continue building the request

Implements GenerallyPositive.Browser.IAllowPuppeteerParametersOrExecution.

Definition at line 1927 of file PupeteerClient.cs.

◆ WithResultName()

IAllowPuppeteerParametersOrExecution GenerallyPositive.Browser.PuppeteerClient.WithResultName ( string name )

Sets the name under which this execution's result will be stored, for later retrieval via the WithXFromResult methods.

Parameters

name	The result name

Returns: Fluent interface to continue building the request

Implements GenerallyPositive.Browser.IAllowPuppeteerEndpointDetails.

Definition at line 1522 of file PupeteerClient.cs.

◆ WithSaveFile()

IAllowPuppeteerEndpointDetails GenerallyPositive.Browser.PuppeteerClient.WithSaveFile ( GPALFile file )

Implements GenerallyPositive.Browser.IAllowPuppeteerEndpointDetails.

Definition at line 1528 of file PupeteerClient.cs.

◆ WithSelectIndex()

IAllowPuppeteerExecution GenerallyPositive.Browser.PuppeteerClient.WithSelectIndex ( int index )

Sets the index of the option to choose from a Select menu.

Parameters

index Zero-based index of the option to choose

Returns: Fluent interface to continue building the request

Implements GenerallyPositive.Browser.IAllowPuppeteerSelectOptions.

Definition at line 3862 of file PupeteerClient.cs.

◆ WithSelectValue()

IAllowPuppeteerExecution GenerallyPositive.Browser.PuppeteerClient.WithSelectValue ( string value )

Set the value to choose from the Select menu.

Parameters

value

Returns

Implements GenerallyPositive.Browser.IAllowPuppeteerSelectOptions.

Definition at line 3852 of file PupeteerClient.cs.

◆ WithSessionToken()

IAllowPuppeteerParametersOrExecution GenerallyPositive.Browser.PuppeteerClient.WithSessionToken ( string sessionToken )

Sets the session token parameter for the request.

Parameters

sessionToken The session token to send

Returns: Fluent interface to continue building the request

Implements GenerallyPositive.Browser.IAllowPuppeteerParametersOrExecution.

Definition at line 1539 of file PupeteerClient.cs.

◆ WithStorageData()

IAllowPuppeteerStorageOptions GenerallyPositive.Browser.PuppeteerClient.WithStorageData ( string data )

Sets the storage data parameter for storage operations.

Parameters

data	The data to store

Returns: Fluent interface to continue building the request

Implements GenerallyPositive.Browser.IAllowPuppeteerStorageOptions.

Definition at line 1711 of file PupeteerClient.cs.

◆ WithStorageDomain()

IAllowPuppeteerStorageOptions GenerallyPositive.Browser.PuppeteerClient.WithStorageDomain ( string domain )

Sets the storage domain parameter for storage operations.

Parameters

domain The domain to scope the storage operation to

Returns: Fluent interface to continue building the request

Implements GenerallyPositive.Browser.IAllowPuppeteerStorageOptions.

Definition at line 1671 of file PupeteerClient.cs.

◆ WithStorageKey()

IAllowPuppeteerStorageOptions GenerallyPositive.Browser.PuppeteerClient.WithStorageKey ( string key )

Sets the storage key parameter for storage operations.

Parameters

key	The storage key

Returns: Fluent interface to continue building the request

Implements GenerallyPositive.Browser.IAllowPuppeteerStorageOptions.

Definition at line 1691 of file PupeteerClient.cs.

◆ WithStoragePath()

IAllowPuppeteerStorageOptions GenerallyPositive.Browser.PuppeteerClient.WithStoragePath ( string path )

Sets the storage path parameter for storage operations.

Parameters

path	The cookie/storage path to scope the operation to

Returns: Fluent interface to continue building the request

Implements GenerallyPositive.Browser.IAllowPuppeteerStorageOptions.

Definition at line 1681 of file PupeteerClient.cs.

◆ WithStorageStoreName()

IAllowPuppeteerStorageOptions GenerallyPositive.Browser.PuppeteerClient.WithStorageStoreName ( string storeName )

Sets the storage store name parameter for IndexedDB storage operations.

Parameters

storeName The object store name

Returns: Fluent interface to continue building the request

Implements GenerallyPositive.Browser.IAllowPuppeteerStorageOptions.

Definition at line 1701 of file PupeteerClient.cs.

◆ WithTabId()

IAllowPuppeteerParametersOrExecution GenerallyPositive.Browser.PuppeteerClient.WithTabId ( int tabId )

Sets the tab id parameter for the request.

Parameters

tabId The tab id

Returns: Fluent interface to continue building the request

Implements GenerallyPositive.Browser.IAllowPuppeteerParametersOrExecution.

Definition at line 1605 of file PupeteerClient.cs.

◆ WithTabIdFromResult() [1/2]

IAllowPuppeteerParametersOrExecution GenerallyPositive.Browser.PuppeteerClient.WithTabIdFromResult ( int resultIndex )

Sets the tab id parameter from the result at the given index of a previous execution.

Parameters

resultIndex Index into the execution results

Returns: Fluent interface to continue building the request

Implements GenerallyPositive.Browser.IAllowPuppeteerParametersOrExecution.

Definition at line 1616 of file PupeteerClient.cs.

◆ WithTabIdFromResult() [2/2]

IAllowPuppeteerParametersOrExecution GenerallyPositive.Browser.PuppeteerClient.WithTabIdFromResult ( string name )

Sets the tab id parameter from the named result of a previous execution.

Parameters

name	Name of a previous execution result

Returns: Fluent interface to continue building the request

Implements GenerallyPositive.Browser.IAllowPuppeteerParametersOrExecution.

Definition at line 1627 of file PupeteerClient.cs.

◆ WithText()

IAllowPuppeteerExecution GenerallyPositive.Browser.PuppeteerClient.WithText ( string text )

Sets the text parameter for the request.

Parameters

text The text

Returns: Fluent interface to continue building the request

Implements GenerallyPositive.Browser.IAllowPuppeteerParametersOrExecution.

Definition at line 1938 of file PupeteerClient.cs.

◆ WithTextFromResult() [1/2]

IAllowPuppeteerExecution GenerallyPositive.Browser.PuppeteerClient.WithTextFromResult ( int resultIndex )

Sets the text parameter from the result at the given index of a previous execution.

Parameters

resultIndex Index into the execution results

Returns: Fluent interface to continue building the request

Implements GenerallyPositive.Browser.IAllowPuppeteerParametersOrExecution.

Definition at line 1950 of file PupeteerClient.cs.

◆ WithTextFromResult() [2/2]

IAllowPuppeteerExecution GenerallyPositive.Browser.PuppeteerClient.WithTextFromResult ( string name )

Sets the text parameter from the named result of a previous execution.

Parameters

name	Name of a previous execution result

Returns: Fluent interface to continue building the request

Implements GenerallyPositive.Browser.IAllowPuppeteerParametersOrExecution.

Definition at line 1961 of file PupeteerClient.cs.

◆ WithTimeoutMs()

IAllowPuppeteerCheckNetworkIdleOrExecution GenerallyPositive.Browser.PuppeteerClient.WithTimeoutMs ( int timeoutMs )

Sets the timeout, in milliseconds, used by CheckNetworkIdle.

Parameters

timeoutMs Timeout in milliseconds

Returns: Fluent interface to continue building the request

Implements GenerallyPositive.Browser.IAllowPuppeteerCheckNetworkIdleOrExecution.

Definition at line 2479 of file PupeteerClient.cs.

◆ WithUrl()

IAllowPuppeteerParametersOrExecution GenerallyPositive.Browser.PuppeteerClient.WithUrl ( string url )

Sets the url parameter for the request.

Parameters

url The URL

Returns: Fluent interface to continue building the request

Implements GenerallyPositive.Browser.IAllowPuppeteerParametersOrExecution.

Definition at line 1561 of file PupeteerClient.cs.

◆ WithUrlFromResult() [1/2]

IAllowPuppeteerParametersOrExecution GenerallyPositive.Browser.PuppeteerClient.WithUrlFromResult ( int resultIndex )

Sets the url parameter from the result at the given index of a previous execution.

Parameters

resultIndex Index into the execution results

Returns: Fluent interface to continue building the request

Implements GenerallyPositive.Browser.IAllowPuppeteerParametersOrExecution.

Definition at line 1583 of file PupeteerClient.cs.

◆ WithUrlFromResult() [2/2]

IAllowPuppeteerParametersOrExecution GenerallyPositive.Browser.PuppeteerClient.WithUrlFromResult ( string name )

Sets the url parameter from the named result of a previous execution.

Parameters

name	Name of a previous execution result

Returns: Fluent interface to continue building the request

Implements GenerallyPositive.Browser.IAllowPuppeteerParametersOrExecution.

Definition at line 1594 of file PupeteerClient.cs.

◆ WithValue()

IAllowPuppeteerAttribute GenerallyPositive.Browser.PuppeteerClient.WithValue ( string value )

Sets the attribute value parameter for SetAttribute requests.

Parameters

value The value to set

Returns: Fluent interface to continue building the request

Implements GenerallyPositive.Browser.IAllowPuppeteerAttribute.

Definition at line 2601 of file PupeteerClient.cs.

◆ WithVerb()

IAllowPuppeteerParametersOrExecution GenerallyPositive.Browser.PuppeteerClient.WithVerb ( string method )

HTTP method for the request. GET when nothing was said.

Parameters

method HTTP method

Returns: Fluent interface to continue building the request

Implements GenerallyPositive.Browser.IAllowPuppeteerActions.

Definition at line 2765 of file PupeteerClient.cs.

◆ WithVPixels()

IAllowPuppeteerScrollElement GenerallyPositive.Browser.PuppeteerClient.WithVPixels ( int vPixels )

Sets the vertical pixels parameter for the request.

Parameters

vPixels Number of vertical pixels

Returns: Fluent interface to continue building the request

Implements GenerallyPositive.Browser.IAllowPuppeteerScrollElement.

Definition at line 2534 of file PupeteerClient.cs.

◆ WithVPixelsFromResult() [1/2]

IAllowPuppeteerParametersOrExecution GenerallyPositive.Browser.PuppeteerClient.WithVPixelsFromResult ( int resultIndex )

Sets the vertical pixels parameter from the result at the given index of a previous execution.

Parameters

resultIndex Index into the execution results

Returns: Fluent interface to continue building the request

Implements GenerallyPositive.Browser.IAllowPuppeteerParametersOrExecution.

Definition at line 2061 of file PupeteerClient.cs.

◆ WithVPixelsFromResult() [2/2]

IAllowPuppeteerParametersOrExecution GenerallyPositive.Browser.PuppeteerClient.WithVPixelsFromResult ( string name )

Sets the vertical pixels parameter from the named result of a previous execution.

Parameters

name	Name of a previous execution result

Returns: Fluent interface to continue building the request

Implements GenerallyPositive.Browser.IAllowPuppeteerParametersOrExecution.

Definition at line 2073 of file PupeteerClient.cs.

◆ WithWindowId()

IAllowPuppeteerParametersOrExecution GenerallyPositive.Browser.PuppeteerClient.WithWindowId ( int windowId )

Sets the window id parameter for the request.

Parameters

windowId The window id

Returns: Fluent interface to continue building the request

Implements GenerallyPositive.Browser.IAllowPuppeteerParametersOrExecution.

Definition at line 1638 of file PupeteerClient.cs.

◆ WithWindowIdFromResult() [1/2]

IAllowPuppeteerParametersOrExecution GenerallyPositive.Browser.PuppeteerClient.WithWindowIdFromResult ( int resultIndex )

Sets the window id parameter from the result at the given index of a previous execution.

Parameters

resultIndex Index into the execution results

Returns: Fluent interface to continue building the request

Implements GenerallyPositive.Browser.IAllowPuppeteerParametersOrExecution.

Definition at line 1649 of file PupeteerClient.cs.

◆ WithWindowIdFromResult() [2/2]

IAllowPuppeteerParametersOrExecution GenerallyPositive.Browser.PuppeteerClient.WithWindowIdFromResult ( string name )

Sets the window id parameter from the named result of a previous execution.

Parameters

name	Name of a previous execution result

Returns: Fluent interface to continue building the request

Implements GenerallyPositive.Browser.IAllowPuppeteerParametersOrExecution.

Definition at line 1660 of file PupeteerClient.cs.

◆ WithWorkflow()

IAllowPuppeteerWorkflow GenerallyPositive.Browser.PuppeteerClient.WithWorkflow ( Action< PuppeteerClient > workflow )

Adds a workflow step that invokes the given action against this client.

Parameters

workflow Action to run as a workflow step

Returns: Fluent interface to continue building the request

Implements GenerallyPositive.Browser.IAllowPuppeteerWorkflow.

Definition at line 2358 of file PupeteerClient.cs.

◆ WithXPath()

IAllowPuppeteerParametersOrExecution GenerallyPositive.Browser.PuppeteerClient.WithXPath ( string xpath )

Sets the xpath parameter for the request.

Parameters

xpath XPath expression

Returns: Fluent interface to continue building the request

Implements GenerallyPositive.Browser.IAllowPuppeteerParametersOrExecution.

Definition at line 1839 of file PupeteerClient.cs.

◆ WithXPathFromResult() [1/2]

IAllowPuppeteerParametersOrExecution GenerallyPositive.Browser.PuppeteerClient.WithXPathFromResult ( int resultIndex )

Sets the xpath parameter from the result at the given index of a previous execution.

Parameters

resultIndex Index into the execution results

Returns: Fluent interface to continue building the request

Implements GenerallyPositive.Browser.IAllowPuppeteerParametersOrExecution.

Definition at line 1850 of file PupeteerClient.cs.

◆ WithXPathFromResult() [2/2]

IAllowPuppeteerParametersOrExecution GenerallyPositive.Browser.PuppeteerClient.WithXPathFromResult ( string name )

Sets the xpath parameter from the named result of a previous execution.

Parameters

name	Name of a previous execution result

Returns: Fluent interface to continue building the request

Implements GenerallyPositive.Browser.IAllowPuppeteerParametersOrExecution.

Definition at line 1861 of file PupeteerClient.cs.

Property Documentation

◆ Name

string GenerallyPositive.Browser.PuppeteerClient.Name

get

The display name assigned to this client via WithName.

Implements GenerallyPositive.Browser.IPuppeteerClient.

Definition at line 1476 of file PupeteerClient.cs.

The documentation for this class was generated from the following file:

Browser/PupeteerClient.cs

Public Member Functions

Properties

Detailed Description

Member Function Documentation

◆ AndThen()

◆ AndThen< T >()

◆ Back()

◆ CaptureVisibleTab()

◆ CastDesktop()

◆ CastTab()

◆ CheckNetworkIdle()

◆ ClearInjectedScripts()

◆ ClearReferrer()

◆ ClearResults()

◆ ClearWorkflows()

◆ CloseTab() [1/2]

◆ CloseTab() [2/2]

◆ CloseWindow() [1/2]

◆ CloseWindow() [2/2]

◆ DeleteStorage()

◆ DownloadTo() [1/2]

◆ DownloadTo() [2/2]

◆ DragAndDrop()

◆ Evaluate()

◆ EvaluateAll()

◆ Execute()

◆ Execute< T >()

◆ ExecuteAsync()

◆ ExecuteAsync< T >()

◆ ExecuteJavaScript()

◆ Fetch()

◆ FillInAppend()

◆ FillInInsert()

◆ FillInOverwrite()

◆ FireChangeEvent()

◆ Focus()

◆ Forward()

◆ FullScreen()

◆ GetAttribute()

◆ GetBoundingClientRect()

◆ GetContentAndCss()

◆ GetCssAttributes()

◆ GetCurrentUrl()

◆ GetCurrentWindow()

◆ GetDomAttributes()

◆ GetDomProperties()

◆ GetElementAttributeHash()

◆ GetExecutionResults() [1/2]

◆ GetExecutionResults() [2/2]

◆ GetLanguages()

◆ GetModifierBitmask()

◆ GetModifiersString()

◆ GetPageSource()

◆ GetParentNode()

◆ GetReadyStatus()

◆ GetShadowRoot()

◆ GetStorage()

◆ GetUserAgent()

◆ GoTo()

◆ GoToTab() [1/2]

◆ GoToTab() [2/2]

◆ GoToWindow() [1/2]

◆ GoToWindow() [2/2]

◆ HideElement()

◆ Hover()

◆ InElement()

◆ InjectScript()

◆ InMainDom()

◆ InShadowDom()

◆ IsClickable()

◆ IsDisplayed()

◆ IsEnabled()

◆ IsEndOfPage()

◆ IsVisibleInViewport() [1/2]

◆ IsVisibleInViewport() [2/2]

◆ LeftClick()

◆ LeftClickAndDownload()

◆ LeftClickAndUpload()

◆ LeftDoubleClick()

◆ Maximize()