GPAL - Generally Positive Automation Library v1.0
GPAL The Fluent Automation LIbrary
Loading...
Searching...
No Matches
GenerallyPositive.IRESTClient Interface Reference
Inheritance diagram for GenerallyPositive.IRESTClient:
GenerallyPositive.IAllowToGPALObject< TResult > GenerallyPositive.IAllowRestMethods GenerallyPositive.IAllowRangeValue GenerallyPositive.IAllowRESTCaptureOptions GenerallyPositive.IAllowRESTStorageOptions GenerallyPositive.IAllowRESTWithUploadFilename GenerallyPositive.IAllowRESTWithDownloadFilename GenerallyPositive.IAllowSelectOptions GenerallyPositive.IAllowRESTWorkflow GenerallyPositive.IAllowRESTInputText GenerallyPositive.IAllowRESTParameters GenerallyPositive.IAllowRESTAttribute GenerallyPositive.IAllowCheckNetworkIdleOrExecution GenerallyPositive.IAllowRESTParametersOrExecution GenerallyPositive.IAllowRESTExecution GenerallyPositive.IAllowRESTDragAndDrop GenerallyPositive.IAllowRESTScrollElement GenerallyPositive.IAllowRESTMethod GenerallyPositive.IAllowRESTEndpointDetails GenerallyPositive.IAllowRESTEndpoint GenerallyPositive.RESTClient

Properties

string Name [get]
int StatusCode [get]
 The HTTP status code the last call came back with.
int RetryAfterSeconds [get]
 The seconds the last call was asked to wait before asking again, zero when it was not asked.

Additional Inherited Members

Public Member Functions inherited from GenerallyPositive.IAllowRESTEndpoint
IAllowRESTEndpointDetails WithAPIBase (string url)
IAllowRESTEndpointDetails WithAPIBase (string url, TimeSpan httpTimeout)
IAllowRESTEndpointDetails LoadOpenAPIMap (string yamlOrUrl)
IAllowRESTEndpointDetails LoadOpenAPIMap (GPALFile openSpiMapFile)
Public Member Functions inherited from GenerallyPositive.IAllowRESTEndpointDetails
IAllowRESTParametersOrExecution WithEndpoint (string endpoint)
IAllowRESTParametersOrExecution WithEndpoint (ApiEndpoint endpoint)
IAllowRESTParametersOrExecution WithResultName (string name)
IAllowRESTEndpointDetails WithName (string name)
IAllowRESTEndpointDetails ListOpenAPIEndPoints ()
Public Member Functions inherited from GenerallyPositive.IAllowRESTExecution
string Execute (bool publishEvent=true)
T Execute< T > (bool publishEvent=true)
IRESTClient AndThen (bool publishEvent=true)
IRESTClient AndThen< T > (bool publishEvent=true)
Task< string > ExecuteAsync (bool publishEvent=true)
Task< T > ExecuteAsync< T > (bool publishEvent=true)
ResultCollection GetExecutionResults ()
IReadOnlyList< object > GetExecutionResults (string name)
IAllowRESTExecution ClearResults ()
IAllowRESTExecution WithHeader (string name, string value)
IAllowRESTExecution WithTimeout (TimeSpan httpTimeout)
Public Member Functions inherited from GenerallyPositive.IAllowRESTMethod
IAllowRESTExecution WithHttpMethod (string method)
Public Member Functions inherited from GenerallyPositive.IAllowRESTParameters
IAllowRESTParametersOrExecution WithParameters (params object[] parameters)
IAllowRESTParametersOrExecution WithParameters (object parameters)
IAllowRESTParametersOrExecution WithParametersFromResult (int resultIndex)
IAllowRESTParametersOrExecution WithParametersFromResult (string name)
IAllowRESTParametersOrExecution WithEncoding (Enums.ContentEncoding encoding)
Public Member Functions inherited from GenerallyPositive.IAllowToGPALObject< TResult >
TResult ToGPALObject ()
Public Member Functions inherited from GenerallyPositive.IAllowRESTScrollElement
IAllowRESTScrollElement WithHPixels (int hPixels)
IAllowRESTScrollElement WithVPixels (int vPixels)
Public Member Functions inherited from GenerallyPositive.IAllowRESTDragAndDrop
IAllowRESTDragAndDrop WithDeltaX (int deltaX)
IAllowRESTDragAndDrop WithDeltaY (int deltaY)
IAllowRESTDragAndDrop WithOffsetX (int offsetX)
IAllowRESTDragAndDrop WithOffsetY (int offsetY)
Public Member Functions inherited from GenerallyPositive.IAllowRESTParametersOrExecution
IAllowRESTParametersOrExecution WithUrl (string url)
IAllowRESTParametersOrExecution WithUrlFromResult (int resultIndex)
IAllowRESTParametersOrExecution WithUrlFromResult (string name)
IAllowRESTParametersOrExecution WithTabId (int tabId)
IAllowRESTParametersOrExecution WithTabIdFromResult (int resultIndex)
IAllowRESTParametersOrExecution WithTabIdFromResult (string name)
IAllowRESTParametersOrExecution WithWindowId (int windowId)
IAllowRESTParametersOrExecution WithWindowIdFromResult (int resultIndex)
IAllowRESTParametersOrExecution WithWindowIdFromResult (string name)
IAllowRESTStorageOptions WithStorageType (WebsiteStorageType storageType)
IAllowRESTParametersOrExecution WithKey (string key)
IAllowRESTParametersOrExecution WithKeyFromResult (int resultIndex)
IAllowRESTParametersOrExecution WithKeyFromResult (string name)
IAllowRESTParametersOrExecution WithCss (string css)
IAllowRESTParametersOrExecution WithCssFromResult (int resultIndex)
IAllowRESTParametersOrExecution WithCssFromResult (string name)
IAllowRESTParametersOrExecution WithElement (IGPALElement gPALElement)
IAllowRESTParametersOrExecution WithXPath (string xpath)
IAllowRESTParametersOrExecution WithXPathFromResult (int resultIndex)
IAllowRESTParametersOrExecution WithXPathFromResult (string name)
IAllowRESTParametersOrExecution WithPixels (int pixels)
IAllowRESTParametersOrExecution WithPixelsFromResult (int resultIndex)
IAllowRESTParametersOrExecution WithPixelsFromResult (string name)
IAllowRESTParametersOrExecution WithReferrer (string referrer)
IAllowRESTParametersOrExecution WithReferrerFromResult (int resultIndex)
IAllowRESTParametersOrExecution WithReferrerFromResult (string name)
IAllowRESTExecution WithText (string text)
IAllowRESTExecution WithTextFromResult (int resultIndex)
IAllowRESTExecution WithTextFromResult (string name)
IAllowRESTParametersOrExecution DownloadTo (GPALFile file)
IAllowRESTParametersOrExecution SaveResultsTo (GPALFile file)
IAllowRESTParametersOrExecution WithElementId (string elementId)
IAllowRESTParametersOrExecution WithElementIdFromResult (int resultIndex)
IAllowRESTParametersOrExecution WithElementIdFromResult (string name)
IAllowRESTParametersOrExecution SetValueFrom (string destSelector)
IAllowRESTScrollElement WithHPixelsFromResult (int resultIndex)
IAllowRESTScrollElement WithHPixelsFromResult (string name)
IAllowRESTScrollElement WithVPixelsFromResult (int resultIndex)
IAllowRESTScrollElement WithVPixelsFromResult (string name)
IAllowRESTExecution WithDeviceName (string deviceNameOrId)
Public Member Functions inherited from GenerallyPositive.IAllowCheckNetworkIdleOrExecution
IAllowCheckNetworkIdleOrExecution WithTimeoutMs (int timeoutMs)
IAllowCheckNetworkIdleOrExecution WithPruneMs (int pruneMs)
IAllowCheckNetworkIdleOrExecution WithMaxConnections (int maxConnections)
Public Member Functions inherited from GenerallyPositive.IAllowRestMethods
IAllowRESTExecution Back ()
IAllowRESTExecution CaptureVisibleTab (ImageFormat imageFormat=ImageFormat.JPEG)
IAllowRESTExecution CloseTab (GPALUrl url=null)
IAllowRESTExecution CloseTab (int tabId)
IAllowRESTExecution CloseWindow (GPALUrl url=null)
IAllowRESTExecution CloseBrowser ()
IAllowRESTExecution CloseWindow (int tabId)
IAllowRESTStorageOptions DeleteStorage (WebsiteStorageType storageType)
IAllowRESTParameters ExecuteJavaScript (string script)
IAllowRESTParameters InjectScript (string script)
IAllowRESTParameters ClearInjectedScripts ()
IAllowRESTInputText FillInAppend (string elementId)
IAllowRESTInputText FillInInsert (string elementId)
IAllowRESTInputText FillInOverwrite (string elementId)
IAllowRESTExecution Forward ()
IAllowRESTExecution FullScreen ()
IAllowRESTExecution GetReadyStatus ()
IAllowRESTExecution CheckNetworkIdle (int maxConnections=0)
IAllowRESTExecution GetShadowRoot (string css)
IAllowRESTStorageOptions GetStorage (WebsiteStorageType storageType)
IAllowRESTExecution GetCurrentUrl ()
IAllowRESTExecution GetCurrentWindow ()
IAllowRESTExecution GetDocumentStamp ()
IAllowRESTExecution GetHydrationScripts ()
IAllowRESTExecution GetOptions (string elementId)
IAllowRESTExecution GetLanguages ()
IAllowRESTCaptureOptions CaptureCalls (bool capture=true)
IAllowRESTExecution GetCapturedCalls ()
IAllowRESTExecution GetUserAgent ()
IAllowRESTExecution GoTo (GPALUrl url)
IAllowRESTExecution GoToTab (GPALUrl url)
IAllowRESTExecution GoToTab (int tabId)
IAllowRESTExecution GoToWindow (GPALUrl url)
IAllowRESTExecution GoToWindow (int tabId)
IAllowRESTExecution Maximize ()
IAllowRESTExecution Minimize ()
IAllowRESTExecution MoveTo (string elementId)
IAllowRESTExecution NewTab (GPALUrl url=null)
IAllowRESTExecution NextTab ()
IAllowRESTExecution TabCount ()
IAllowRESTExecution NextWindow ()
IAllowRESTExecution Normal ()
IAllowRESTExecution OpenWindow (GPALUrl url=null)
IAllowRESTExecution OverrideReferrer (string referrer)
IAllowRESTExecution PageDown (int pagesToScroll=1)
IAllowRESTExecution PageEnd ()
IAllowRESTExecution PageTop ()
IAllowRESTExecution PageUp (int pagesToScroll=1)
IAllowRESTExecution PressModifierKey (ModifierKeys modifierKeys)
IAllowRESTExecution PreviousTab ()
IAllowRESTExecution PreviousWindow ()
IAllowRESTExecution Refresh ()
IAllowRESTExecution ReleaseModifierKey (ModifierKeys modifierKeys)
IAllowRESTExecution Restore ()
IAllowRESTExecution ScrollWindowByHorizontal (int pixels)
IAllowRESTExecution ScrollWindowByVertical (int pixels)
IAllowRESTExecution SendString (string text, int delayMs=0)
 Simulates typing in OttoMagic: dispatches key events character-by-character. Honors GPAL.TypingDelay when delayMs is left at its default (0). See GPAL.WithTypingDelay for the SendString vs. FillIn guidance.
IAllowRESTExecution SendKey (byte vkcode)
IAllowRangeValue SetRange (string elementId)
IAllowRESTStorageOptions SetStorage (WebsiteStorageType storageType)
IAllowRESTExecution SetUserAgent (string userAgent)
IAllowRESTExecution SetGoogleReferrer ()
IAllowRESTExecution SwitchToDefaultContent ()
IAllowRESTExecution SwitchToElement (string elementId)
IAllowRESTExecution SwitchToFrame (string elementId)
IAllowRESTExecution SwitchToShadowRoot (string elementId)
IAllowRESTExecution GetWorkflow ()
IAllowRESTExecution GetSettings ()
IAllowRESTExecution GetGpalSettings ()
IAllowRESTExecution GetBrowserSettings ()
IAllowRESTExecution FireChangeEvent (string elementId)
IAllowRESTExecution Focus (string elementId)
IAllowRESTExecution GetBoundingClientRect (string elementId)
IAllowRESTExecution ElementFromPoint (string elementId, int x, int y)
IAllowRESTExecution TrustedLeftClick (int x, int y, int holdMs=0)
IAllowRESTExecution TrustedMiddleClick (int x, int y, int holdMs=0)
IAllowRESTExecution GetElementAttributeHash (string elementId)
IAllowRESTExecution GetPageSource ()
IAllowRESTExecution GetParentNode (string elementId)
IAllowRESTExecution GetContentAndCss (string selector)
IAllowRESTExecution GetCssAttributes (string selector)
IAllowRESTExecution GetDomAttributes (string selector)
IAllowRESTExecution GetDomProperties (string selector)
IAllowRESTExecution GetWindowRectangle ()
IAllowRESTExecution HideElement (string elementId)
IAllowRESTExecution IsClickable (string elementId)
IAllowRESTExecution IsDisplayed (string elementId)
IAllowRESTExecution IsEnabled (string elementId)
IAllowRESTExecution IsEndOfPage ()
IAllowRESTExecution IsVisibleInViewport (string elementId)
IAllowRESTExecution LeftClick (string elementId)
IAllowRESTWithDownloadFilename LeftClickAndDownload (string elementId)
IAllowRESTExecution SetDownloadFilename (string downloadPath)
IAllowRESTWithUploadFilename LeftClickAndUpload (string elementId)
IAllowRESTExecution LeftDoubleClick (string elementId)
IAllowRESTExecution MiddleClick (string elementId)
IAllowRESTExecution RightClick (string elementId)
IAllowRESTExecution ScrollIntoView (string elementId)
IAllowRESTExecution WindowInnerHeight ()
IAllowRESTExecution WindowInnerWidth ()
IAllowRESTExecution WindowOuterHeight ()
IAllowRESTExecution WindowOuterWidth ()
IAllowRESTParametersOrExecution Fetch (string url)
IAllowRESTParametersOrExecution WithVerb (string method)
IAllowRESTParametersOrExecution WithBody (string body)
IAllowRESTParametersOrExecution WithContentType (string contentType)
IAllowRESTParametersOrExecution WithHeaders (string[] headers)
IAllowRESTParametersOrExecution WithBytes (bool bytes)
IAllowRESTExecution WindowPageOffsetX ()
IAllowRESTExecution WindowPageOffsetY ()
IAllowRESTExecution WindowScreenLeft ()
IAllowRESTExecution WindowScreenTop ()
IAllowRESTExecution Hover (string elementId)
IAllowRESTExecution EvaluatePersistent (string xpath)
IAllowRESTExecution EvaluateAllPersistent (string xpath)
IAllowRESTExecution QueryPersistentSelector (string css)
IAllowRESTExecution QueryPersistentSelectors (string css)
IAllowRESTExecution Evaluate (string xpath)
IAllowRESTExecution EvaluateAll (string xpath)
IAllowRESTExecution QuerySelector (string css)
IAllowRESTExecution QuerySelectors (string css)
IAllowRESTExecution ScrollWindow (int hPixels, int vPixels)
IAllowRESTExecution TopBrowser ()
IAllowRESTExecution ClearReferrer ()
IAllowSelectOptions SelectClick (string elementId)
IAllowRESTAttribute SetAttribute (string elementId)
IAllowRESTScrollElement ScrollElement (string elementId)
IAllowRESTExecution ScrollElement (int hPixels, int vPixels)
IAllowRESTDragAndDrop DragAndDrop (string elementId)
IAllowRESTAttribute GetAttribute (string elementId)
Public Member Functions inherited from GenerallyPositive.IAllowRESTAttribute
IAllowRESTAttribute WithAttribute (string attribute)
IAllowRESTAttribute WithValue (string value)
Public Member Functions inherited from GenerallyPositive.IAllowRESTInputText
IAllowRESTExecution WithText (string text)
Public Member Functions inherited from GenerallyPositive.IAllowRESTWorkflow
IAllowRESTWorkflow WithWorkflow (Action< RESTClient > workflow)
IAllowRESTWorkflow ClearWorkflows ()
IAllowRESTParametersOrExecution While (Func< bool > condition)
IAllowRESTParametersOrExecution Until (Func< bool > condition)
Public Member Functions inherited from GenerallyPositive.IAllowSelectOptions
IAllowRESTExecution WithSelectValue (string value)
IAllowRESTExecution WithSelectIndex (int index)
Public Member Functions inherited from GenerallyPositive.IAllowRESTWithDownloadFilename
IAllowRESTExecution WithDownloadFile (string downloadPath)
Public Member Functions inherited from GenerallyPositive.IAllowRESTWithUploadFilename
IAllowRESTExecution WithUploadFile (string uploadFilenameAndPath)
IAllowRESTExecution WithUploadFiles (GPALFile uploadFilenamesAndPaths)
Public Member Functions inherited from GenerallyPositive.IAllowRESTStorageOptions
IAllowRESTStorageOptions WithStorageDomain (string domain)
IAllowRESTStorageOptions WithStoragePath (string path)
IAllowRESTStorageOptions WithStorageKey (string key)
IAllowRESTStorageOptions WithStorageStoreName (string storeName)
IAllowRESTStorageOptions WithData (string data)
IAllowRESTStorageOptions WithDeleteAcrossOrigins (bool trueFalse)
Public Member Functions inherited from GenerallyPositive.IAllowRESTCaptureOptions
IAllowRESTCaptureOptions WithCallFilter (string urlFragment)
IAllowRESTCaptureOptions WithClearCalls (bool clear=true)
Public Member Functions inherited from GenerallyPositive.IAllowRangeValue
IAllowRESTExecution WithRangeValue (int rangeValue)

Detailed Description

Definition at line 1614 of file Interfaces.cs.

Property Documentation

◆ Name

string GenerallyPositive.IRESTClient.Name
get

Implemented in GenerallyPositive.RESTClient.

Definition at line 1618 of file Interfaces.cs.

◆ RetryAfterSeconds

int GenerallyPositive.IRESTClient.RetryAfterSeconds
get

The seconds the last call was asked to wait before asking again, zero when it was not asked.

Implemented in GenerallyPositive.RESTClient.

Definition at line 1624 of file Interfaces.cs.

◆ StatusCode

int GenerallyPositive.IRESTClient.StatusCode
get

The HTTP status code the last call came back with.

Implemented in GenerallyPositive.RESTClient.

Definition at line 1621 of file Interfaces.cs.

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