Interface IRESTClient

Inherited Members
Namespace: GenerallyPositive
Assembly: GPAL.dll
Syntax
public interface IRESTClient : IAllowRESTEndpoint, IAllowRESTEndpointDetails, IAllowRESTParametersOrExecution, IAllowRESTParameters, IAllowRESTMethod, IAllowRESTScript, IAllowRESTWorkflow, IAllowRESTWorkflowDefinition, IAllowCheckNetworkIdleOrExecution, IAllowRESTExecution, IAllowToGPALObject<RESTClient>

Properties

Name

Declaration
string Name { get; }
Property Value
Type Description
System.String

Methods

Back()

Declaration
IAllowRESTExecution Back()
Returns
Type Description
IAllowRESTExecution

CheckNetworkIdle(Int32)

Declaration
IAllowRESTExecution CheckNetworkIdle(int maxConnections = 0)
Parameters
Type Name Description
System.Int32 maxConnections
Returns
Type Description
IAllowRESTExecution

CloseTab(Int32)

Declaration
IAllowRESTExecution CloseTab(int tabId)
Parameters
Type Name Description
System.Int32 tabId
Returns
Type Description
IAllowRESTExecution

CloseTab(String)

Declaration
IAllowRESTExecution CloseTab(string url = null)
Parameters
Type Name Description
System.String url
Returns
Type Description
IAllowRESTExecution

Evaluate(String)

Declaration
IAllowRESTExecution Evaluate(string xpath)
Parameters
Type Name Description
System.String xpath
Returns
Type Description
IAllowRESTExecution

EvaluateAll(String)

Declaration
IAllowRESTExecution EvaluateAll(string xpath)
Parameters
Type Name Description
System.String xpath
Returns
Type Description
IAllowRESTExecution

ExecuteJavaScript(String)

Declaration
IAllowRESTExecution ExecuteJavaScript(string script)
Parameters
Type Name Description
System.String script
Returns
Type Description
IAllowRESTExecution

ExecuteJavaScript(String, Object[])

Declaration
IAllowRESTExecution ExecuteJavaScript(string script, params object[] args)
Parameters
Type Name Description
System.String script
System.Object[] args
Returns
Type Description
IAllowRESTExecution

Forward()

Declaration
IAllowRESTExecution Forward()
Returns
Type Description
IAllowRESTExecution

FullScreen()

Declaration
IAllowRESTExecution FullScreen()
Returns
Type Description
IAllowRESTExecution

GetBrowserSettings()

Declaration
IAllowRESTExecution GetBrowserSettings()
Returns
Type Description
IAllowRESTExecution

GetContentAndCss(String)

Declaration
IAllowRESTExecution GetContentAndCss(string selectorPath)
Parameters
Type Name Description
System.String selectorPath
Returns
Type Description
IAllowRESTExecution

GetCurrentUrl()

Declaration
IAllowRESTExecution GetCurrentUrl()
Returns
Type Description
IAllowRESTExecution

GetGpalSettings()

Declaration
IAllowRESTExecution GetGpalSettings()
Returns
Type Description
IAllowRESTExecution

GetReadyStatus()

Declaration
IAllowRESTExecution GetReadyStatus()
Returns
Type Description
IAllowRESTExecution

GetSettings()

Declaration
IAllowRESTExecution GetSettings()
Returns
Type Description
IAllowRESTExecution

GetShadowRoot(String)

Declaration
IAllowRESTExecution GetShadowRoot(string css)
Parameters
Type Name Description
System.String css
Returns
Type Description
IAllowRESTExecution

GetUserAgent()

Declaration
IAllowRESTExecution GetUserAgent()
Returns
Type Description
IAllowRESTExecution

GetWorkflow()

Declaration
IAllowRESTExecution GetWorkflow()
Returns
Type Description
IAllowRESTExecution

Goto(String)

Declaration
IAllowRESTExecution Goto(string url)
Parameters
Type Name Description
System.String url
Returns
Type Description
IAllowRESTExecution

GotoTab(Int32)

Declaration
IAllowRESTExecution GotoTab(int tabId)
Parameters
Type Name Description
System.Int32 tabId
Returns
Type Description
IAllowRESTExecution

GotoTab(String)

Declaration
IAllowRESTExecution GotoTab(string url)
Parameters
Type Name Description
System.String url
Returns
Type Description
IAllowRESTExecution

Hover(String)

Declaration
IAllowRESTExecution Hover(string selector)
Parameters
Type Name Description
System.String selector
Returns
Type Description
IAllowRESTExecution

InIFrame(String)

Declaration
IAllowRESTExecution InIFrame(string selector)
Parameters
Type Name Description
System.String selector
Returns
Type Description
IAllowRESTExecution

InMainDom(String)

Declaration
IAllowRESTExecution InMainDom(string selector)
Parameters
Type Name Description
System.String selector
Returns
Type Description
IAllowRESTExecution

InputText(String)

Declaration
IAllowRESTExecution InputText(string selector)
Parameters
Type Name Description
System.String selector
Returns
Type Description
IAllowRESTExecution

InShadowDom(String)

Declaration
IAllowRESTExecution InShadowDom(string selector)
Parameters
Type Name Description
System.String selector
Returns
Type Description
IAllowRESTExecution

LeftClick(String)

Declaration
IAllowRESTExecution LeftClick(string selector)
Parameters
Type Name Description
System.String selector
Returns
Type Description
IAllowRESTExecution

LeftClickAndDownload(String)

Declaration
IAllowRESTExecution LeftClickAndDownload(string selector)
Parameters
Type Name Description
System.String selector
Returns
Type Description
IAllowRESTExecution

LeftDoubleClick(String)

Declaration
IAllowRESTExecution LeftDoubleClick(string selector)
Parameters
Type Name Description
System.String selector
Returns
Type Description
IAllowRESTExecution

Maximize()

Declaration
IAllowRESTExecution Maximize()
Returns
Type Description
IAllowRESTExecution

Minimize()

Declaration
IAllowRESTExecution Minimize()
Returns
Type Description
IAllowRESTExecution

MoveTo(String)

Declaration
IAllowRESTExecution MoveTo(string selector)
Parameters
Type Name Description
System.String selector
Returns
Type Description
IAllowRESTExecution

NewTab(String)

Declaration
IAllowRESTExecution NewTab(string url = null)
Parameters
Type Name Description
System.String url
Returns
Type Description
IAllowRESTExecution

NextTab()

Declaration
IAllowRESTExecution NextTab()
Returns
Type Description
IAllowRESTExecution

Normal()

Declaration
IAllowRESTExecution Normal()
Returns
Type Description
IAllowRESTExecution

OverrideReferrr(String)

Declaration
IAllowRESTExecution OverrideReferrr(string referrer)
Parameters
Type Name Description
System.String referrer
Returns
Type Description
IAllowRESTExecution

PageDown(Int32)

Declaration
IAllowRESTExecution PageDown(int pagesToScroll = 1)
Parameters
Type Name Description
System.Int32 pagesToScroll
Returns
Type Description
IAllowRESTExecution

PageEnd()

Declaration
IAllowRESTExecution PageEnd()
Returns
Type Description
IAllowRESTExecution

PageTop()

Declaration
IAllowRESTExecution PageTop()
Returns
Type Description
IAllowRESTExecution

PageUp(Int32)

Declaration
IAllowRESTExecution PageUp(int pagesToScroll = 1)
Parameters
Type Name Description
System.Int32 pagesToScroll
Returns
Type Description
IAllowRESTExecution

PreviousTab()

Declaration
IAllowRESTExecution PreviousTab()
Returns
Type Description
IAllowRESTExecution

QuerySelector(String)

Declaration
IAllowRESTExecution QuerySelector(string css)
Parameters
Type Name Description
System.String css
Returns
Type Description
IAllowRESTExecution

QuerySelectors(String)

Declaration
IAllowRESTExecution QuerySelectors(string css)
Parameters
Type Name Description
System.String css
Returns
Type Description
IAllowRESTExecution

Refresh()

Declaration
IAllowRESTExecution Refresh()
Returns
Type Description
IAllowRESTExecution

Restore()

Declaration
IAllowRESTExecution Restore()
Returns
Type Description
IAllowRESTExecution

RightClick(String)

Declaration
IAllowRESTExecution RightClick(string selector)
Parameters
Type Name Description
System.String selector
Returns
Type Description
IAllowRESTExecution

RightClickAndDownload(String)

Declaration
IAllowRESTExecution RightClickAndDownload(string selector)
Parameters
Type Name Description
System.String selector
Returns
Type Description
IAllowRESTExecution

ScrollByHorizontal(Int32)

Declaration
IAllowRESTExecution ScrollByHorizontal(int pixels)
Parameters
Type Name Description
System.Int32 pixels
Returns
Type Description
IAllowRESTExecution

ScrollByVertical(Int32)

Declaration
IAllowRESTExecution ScrollByVertical(int pixels)
Parameters
Type Name Description
System.Int32 pixels
Returns
Type Description
IAllowRESTExecution

ScrollWindowByHorizontal(Int32)

Declaration
IAllowRESTExecution ScrollWindowByHorizontal(int pixels)
Parameters
Type Name Description
System.Int32 pixels
Returns
Type Description
IAllowRESTExecution

ScrollWindowByVertical(Int32)

Declaration
IAllowRESTExecution ScrollWindowByVertical(int pixels)
Parameters
Type Name Description
System.Int32 pixels
Returns
Type Description
IAllowRESTExecution

SendKey(String)

Declaration
IAllowRESTExecution SendKey(string key)
Parameters
Type Name Description
System.String key
Returns
Type Description
IAllowRESTExecution

SendString(String)

Declaration
IAllowRESTExecution SendString(string text)
Parameters
Type Name Description
System.String text
Returns
Type Description
IAllowRESTExecution

StealthOverrideReferrr()

Declaration
IAllowRESTExecution StealthOverrideReferrr()
Returns
Type Description
IAllowRESTExecution

SubmitForm(String)

Declaration
IAllowRESTExecution SubmitForm(string elementId)
Parameters
Type Name Description
System.String elementId
Returns
Type Description
IAllowRESTExecution

SwitchToDefaultContent()

Declaration
IAllowRESTExecution SwitchToDefaultContent()
Returns
Type Description
IAllowRESTExecution

SwitchToFrame(String)

Declaration
IAllowRESTExecution SwitchToFrame(string elementId)
Parameters
Type Name Description
System.String elementId
Returns
Type Description
IAllowRESTExecution

SwitchToShadowRoot(String)

Declaration
IAllowRESTExecution SwitchToShadowRoot(string elementId)
Parameters
Type Name Description
System.String elementId
Returns
Type Description
IAllowRESTExecution