Class RESTClient

Fluent REST client for making API calls with a chained interface. Supports defining workflows, executing them in loops, and accessing results. Results are accessed via a non-generic indexer, requiring casting to the desired type.

Inheritance
System.Object
RESTClient
Inherited Members
System.Object.ToString()
System.Object.Equals(System.Object)
System.Object.Equals(System.Object, System.Object)
System.Object.ReferenceEquals(System.Object, System.Object)
System.Object.GetHashCode()
System.Object.GetType()
System.Object.MemberwiseClone()
Namespace: GenerallyPositive
Assembly: GPAL.dll
Syntax
public class RESTClient : IRESTClient, IAllowRESTEndpoint, IAllowRESTEndpointDetails, IAllowRESTParametersOrExecution, IAllowRESTParameters, IAllowRESTMethod, IAllowRESTScript, IAllowRESTWorkflow, IAllowRESTWorkflowDefinition, IAllowCheckNetworkIdleOrExecution, IAllowRESTExecution, IAllowToGPALObject<RESTClient>
Examples
// First example: Looping with XPath and status checks
RESTClient client = GPAL.RESTClient
    .WithAPIBase(GPAL.OttoMagicRestApiBaseUrl)
    .WithName("LoopClient")
    // Define first workflow: evaluate an XPath and store result as "item"
    .WithWorkflow(c => c
        .WithEndpoint(ApiEndpoint.Evaluate) // Maps to "/evaluate"
        .WithXPath("//div[@class='item']")   // XPath to evaluate
        .WithResultName("item")
        .Execute<string>()
    )
    // Define second workflow: check status and store result as "status"
    .WithWorkflow(c => c
        .WithEndpoint(ApiEndpoint.CheckStatus) // Maps to "/status"
        .WithResultName("status")
        .Execute<bool>()
    )
    // Execute both workflows in a loop until "item" matches "targetValue"
    .While(() => (string)GetExecutionResults()["item"] != "targetValue")
    // Continue with another operation: input text using the "item" result
    .WithEndpoint(ApiEndpoint.InputText) // Maps to "/input-text"
    .WithXPath("//input[@id='search']")
    .WithTextFromResult("item")
    .Execute();

var results = GetExecutionResults();
Console.WriteLine($"Last Item: [{(string)results["item"]}]");
Console.WriteLine($"Last Status: [{(bool)results["status"]}]");
Console.WriteLine($"Item from iteration 0: [{(string)results["item", 0]}]");
Console.WriteLine($"Status from iteration 0: [{(bool)results["status", 0]}]");
// Second example: Executing JavaScript and chaining result
RESTClient client = GPAL.RESTClient
    .WithAPIBase(GPAL.OttoMagicRestApiBaseUrl)
    .WithName("JavaScriptClient")
    // Execute JavaScript to get the page title and store it as "pageTitle"
    .WithEndpoint(ApiEndpoint.ExecuteJavaScript) // Maps to "/execute-javascript"
    .WithParameters("return document.title", new object[] { }) // JavaScript code and arguments
    .WithResultName("pageTitle")
    .ExecuteAndChain<string>()

    // Chain the result: use the page title in an input text operation
    .WithEndpoint(ApiEndpoint.InputText) // Maps to "/input-text"
    .WithXPath("//input[@id='search']")
    .WithTextFromResult("pageTitle")
    .Execute();

var results = GetExecutionResults();
Console.WriteLine($"Page Title: [{(string)results["pageTitle"]}]");
Console.WriteLine($"Page Title from iteration 0: [{(string)results["pageTitle", 0]}]");

Properties

Name

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

Methods

Back()

Move back in browswer history for current tab

Declaration
public IAllowRESTExecution Back()
Returns
Type Description
IAllowRESTExecution

CheckNetworkIdle(Int32)

Emulate Playwrights network idle check, better than readystatus ensuring javascript/background network tasks are done on the page

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

CloseTab(Int32)

Close the current tab

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

CloseTab(String)

Close the current tab

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

Evaluate(String)

Evaluates an XPath selector to return a single element.

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

The XPath selector (e.g., "//div[1]").
Returns
Type Description
IAllowRESTExecution

An IAllowRESTExecution for executing the query.

EvaluateAll(String)

Evaluates an XPath selector to return all matching elements.

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

The XPath selector (e.g., "//p").
Returns
Type Description
IAllowRESTExecution

An IAllowRESTExecution for executing the query.

Execute()

Declaration
public string Execute()
Returns
Type Description
System.String

Execute<T>()

Declaration
public T Execute<T>()
Returns
Type Description
T
Type Parameters
Name Description
T

ExecuteAndChain()

Declaration
public IAllowRESTParametersOrExecution ExecuteAndChain()
Returns
Type Description
IAllowRESTParametersOrExecution

ExecuteAndChain<T>()

Declaration
public IAllowRESTParametersOrExecution ExecuteAndChain<T>()
Returns
Type Description
IAllowRESTParametersOrExecution
Type Parameters
Name Description
T

ExecuteAsync()

Declaration
public async Task<string> ExecuteAsync()
Returns
Type Description
System.Threading.Tasks.Task<System.String>

ExecuteAsync<T>()

Declaration
public async Task<T> ExecuteAsync<T>()
Returns
Type Description
System.Threading.Tasks.Task<T>
Type Parameters
Name Description
T

ExecuteCheckStatus()

Declaration
public bool ExecuteCheckStatus()
Returns
Type Description
System.Boolean

ExecuteCheckStatusAsync()

Declaration
public async Task<bool> ExecuteCheckStatusAsync()
Returns
Type Description
System.Threading.Tasks.Task<System.Boolean>

ExecuteJavaScript(String)

Executes a JavaScript snippet in the browser.

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

The JavaScript code to execute (e.g., "alert('Test');").
Returns
Type Description
IAllowRESTExecution

An IAllowRESTExecution for executing the action.

ExecuteJavaScript(String, Object[])

Executes a JavaScript snippet in the browser.

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

The JavaScript code to execute (e.g., "alert('Test');").
System.Object[] args
Returns
Type Description
IAllowRESTExecution

An IAllowRESTExecution for executing the action.

Forward()

Move forward in browswer history for current tab

Declaration
public IAllowRESTExecution Forward()
Returns
Type Description
IAllowRESTExecution

FullScreen()

Sets the browser to full-screen mode.

Declaration
public IAllowRESTExecution FullScreen()
Returns
Type Description
IAllowRESTExecution

An IAllowRESTExecution for executing the action.

GetBrowserSettings()

Retrieves browser-specific settings.

Declaration
public IAllowRESTExecution GetBrowserSettings()
Returns
Type Description
IAllowRESTExecution

An IAllowRESTExecution for executing the request.

GetContentAndCss(String)

Return a string which is the content and css for the element defined by SelectorPath If no SelectorPath is provided, it is the whole webpage. THis is used by the Browser.PrintToPDF method to clone a page and then load another browser to print to pdf in headless or windowed mode.

Declaration
public IAllowRESTExecution GetContentAndCss(string SelectorPath)
Parameters
Type Name Description
System.String SelectorPath

css or xpath
Returns
Type Description
IAllowRESTExecution

GetCurrentUrl()

Get the current tab url

Declaration
public IAllowRESTExecution GetCurrentUrl()
Returns
Type Description
IAllowRESTExecution

GetExecutionResults()

Declaration
public ResultCollection GetExecutionResults()
Returns
Type Description
ResultCollection

GetGpalSettings()

Retrieves GPAL-specific settings.

Declaration
public IAllowRESTExecution GetGpalSettings()
Returns
Type Description
IAllowRESTExecution

An IAllowRESTExecution for executing the request.

GetReadyStatus()

Get the brownser document.readyState (is page ready and loaded)

Declaration
public IAllowRESTExecution GetReadyStatus()
Returns
Type Description
IAllowRESTExecution

GetSettings()

Retrieves general settings.

Declaration
public IAllowRESTExecution GetSettings()
Returns
Type Description
IAllowRESTExecution

An IAllowRESTExecution for executing the request.

GetShadowRoot(String)

Get shadow root of element found by Css selector

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

GetUserAgent()

Get the useragent string from the browser

Declaration
public IAllowRESTExecution GetUserAgent()
Returns
Type Description
IAllowRESTExecution

UserAgent string

GetWorkflow()

Retrieves the current workflow settings.

Declaration
public IAllowRESTExecution GetWorkflow()
Returns
Type Description
IAllowRESTExecution

An IAllowRESTExecution for executing the request.

Goto(String)

Navigates the browser to a specified URL.

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

The URL to navigate to (e.g., "https://example.com").
Returns
Type Description
IAllowRESTExecution

An IAllowRESTExecution for executing the action.

GotoTab(Int32)

Switches to a tab by ID.

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

The ID of the tab to switch to.
Returns
Type Description
IAllowRESTExecution

An IAllowRESTExecution for executing the action.

GotoTab(String)

Switches to a tab by URL.

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

The URL of the tab to switch to.
Returns
Type Description
IAllowRESTExecution

An IAllowRESTExecution for executing the action.

Hover(String)

Hovers over an element identified by an XPath or CSS selector.

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

The XPath (e.g., "//button") or CSS (e.g., "#btn") selector.
Returns
Type Description
IAllowRESTExecution

An IAllowRESTExecution for executing the action.

InIFrame(String)

Switch to iframe to find elements, can be nested

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

InMainDom(String)

Go back to the main document dom to find elements

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

InputText(String)

Inputs text into an element, expecting prior .WithText() to set the text.

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

The XPath (e.g., "//input") or CSS (e.g., ".field") selector.
Returns
Type Description
IAllowRESTExecution

An IAllowRESTExecution for executing the action.
Remarks

Must be preceded by .WithText() to specify the text to input.

InShadowDom(String)

Switch to shadowDom to find element. NOTE: Can be xpath for top level, but if nested, nested shadowdom selectors must be css

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

LeftClick(String)

Performs a left-click on an element identified by an XPath or CSS selector.

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

The XPath (e.g., "//a") or CSS (e.g., "#link") selector.
Returns
Type Description
IAllowRESTExecution

An IAllowRESTExecution for executing the action.

LeftClickAndDownload(String)

Performs a left-click and initiates a download from an element identified by an XPath or CSS selector.

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

The XPath (e.g., "//img") or CSS (e.g., ".image-link") selector.
Returns
Type Description
IAllowRESTExecution

An IAllowRESTParametersOrExecution to chain .SaveTo() for the download path.

LeftDoubleClick(String)

Performs a left double-click on an element identified by an XPath or CSS selector.

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

The XPath (e.g., "//span") or CSS (e.g., ".item") selector.
Returns
Type Description
IAllowRESTExecution

An IAllowRESTExecution for executing the action.

Maximize()

Maximizes the browser window.

Declaration
public IAllowRESTExecution Maximize()
Returns
Type Description
IAllowRESTExecution

An IAllowRESTExecution for executing the action.

Minimize()

Minimizes the browser window.

Declaration
public IAllowRESTExecution Minimize()
Returns
Type Description
IAllowRESTExecution

An IAllowRESTExecution for executing the action.

MoveTo(String)

Moves the cursor to an element identified by an XPath or CSS selector.

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

The XPath (e.g., "//div") or CSS (e.g., ".target") selector.
Returns
Type Description
IAllowRESTExecution

An IAllowRESTExecution for executing the action.

NewTab(String)

Create a new tab in the browser

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

An IAllowRESTExecution for executing the action.

NextTab()

Switches to the next tab.

Declaration
public IAllowRESTExecution NextTab()
Returns
Type Description
IAllowRESTExecution

An IAllowRESTExecution for executing the action.

Normal()

Restore browser / exit from fullscreen mode

Declaration
public IAllowRESTExecution Normal()
Returns
Type Description
IAllowRESTExecution

OverrideReferrr(String)

Set google.com as the referrer in the browser, stealth operation

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

PageDown(Int32)

Scroll the current page down one page

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

PageEnd()

Scroll the current page down to the end

Declaration
public IAllowRESTExecution PageEnd()
Returns
Type Description
IAllowRESTExecution

PageTop()

Scroll to the top of the current page

Declaration
public IAllowRESTExecution PageTop()
Returns
Type Description
IAllowRESTExecution

PageUp(Int32)

Scroll the current page up one page

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

PreviousTab()

Switches to the previous tab.

Declaration
public IAllowRESTExecution PreviousTab()
Returns
Type Description
IAllowRESTExecution

An IAllowRESTExecution for executing the action.

QuerySelector(String)

Queries a single element using a CSS selector.

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

The CSS selector (e.g., ".class", "#id").
Returns
Type Description
IAllowRESTExecution

An IAllowRESTExecution for executing the query.

QuerySelectors(String)

Queries all elements matching a CSS selector.

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

The CSS selector (e.g., ".items", "div > p").
Returns
Type Description
IAllowRESTExecution

An IAllowRESTExecution for executing the query.

Refresh()

Refresh the current tab

Declaration
public IAllowRESTExecution Refresh()
Returns
Type Description
IAllowRESTExecution

Restore()

Declaration
public IAllowRESTExecution Restore()
Returns
Type Description
IAllowRESTExecution

RightClick(String)

Performs a right-click on an element identified by an XPath or CSS selector.

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

The XPath (e.g., "//a") or CSS (e.g., "#menu") selector.
Returns
Type Description
IAllowRESTExecution

An IAllowRESTExecution for executing the action.

RightClickAndDownload(String)

Performs a right-click and initiates a download from an element identified by an XPath or CSS selector.

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

The XPath (e.g., "//a[@href]") or CSS (e.g., ".download") selector.
Returns
Type Description
IAllowRESTExecution

An IAllowRESTParametersOrExecution to chain .SaveTo() for the download path.

SaveTo(IGPALFile)

Declaration
public IAllowRESTExecution SaveTo(IGPALFile file)
Parameters
Type Name Description
IGPALFile file
Returns
Type Description
IAllowRESTExecution

ScrollByHorizontal(Int32)

Scrolls an element horizontally by a specified number of pixels, expecting prior .WithXPath() or .WithCss().

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

The number of pixels to scroll horizontally (positive for right, negative for left).
Returns
Type Description
IAllowRESTExecution

An IAllowRESTExecution for executing the action.
Remarks

Must be preceded by .WithXPath() or .WithCss() to specify the target element.

ScrollByVertical(Int32)

Scrolls an element vertically by a specified number of pixels, expecting prior .WithXPath() or .WithCss().

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

The number of pixels to scroll vertically (positive for down, negative for up).
Returns
Type Description
IAllowRESTExecution

An IAllowRESTExecution for executing the action.
Remarks

Must be preceded by .WithXPath() or .WithCss() to specify the target element.

ScrollWindowByHorizontal(Int32)

Scrolls the entire window horizontally by a specified number of pixels.

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

The number of pixels to scroll horizontally (positive for right, negative for left).
Returns
Type Description
IAllowRESTExecution

An IAllowRESTExecution for executing the action.

ScrollWindowByVertical(Int32)

Scrolls the entire window vertically by a specified number of pixels.

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

The number of pixels to scroll vertically (positive for down, negative for up).
Returns
Type Description
IAllowRESTExecution

An IAllowRESTExecution for executing the action.

SendKey(String)

Sends a single key press to the active element or context.

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

The key to send (e.g., "Enter", "Tab").
Returns
Type Description
IAllowRESTExecution

An IAllowRESTExecution for executing the action.

SendString(String)

Sends a string of text as input to the active element or context.

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

The text to send (e.g., "Hello World").
Returns
Type Description
IAllowRESTExecution

An IAllowRESTExecution for executing the action.

StealthOverrideReferrr()

Set google.com as the referrer in the browser, stealth operation

Declaration
public IAllowRESTExecution StealthOverrideReferrr()
Returns
Type Description
IAllowRESTExecution

SubmitForm(String)

Submits a form identified by an element within it.

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

The unique identifier of an element within the form (e.g., data-element-id).
Returns
Type Description
IAllowRESTExecution

An IAllowRESTExecution for executing the action.

SwitchToDefaultContent()

Switches the browser context to the default content (top-level page).

Declaration
public IAllowRESTExecution SwitchToDefaultContent()
Returns
Type Description
IAllowRESTExecution

An IAllowRESTExecution for executing the action.

SwitchToFrame(String)

Switches the browser context to a specific iframe identified by an element.

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

The unique identifier of the iframe element (e.g., data-element-id).
Returns
Type Description
IAllowRESTExecution

An IAllowRESTExecution for executing the action.

SwitchToShadowRoot(String)

Switches the browser context to the shadow root of a specified host element.

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

The unique identifier of the host element containing the shadow root (e.g., data-element-id).
Returns
Type Description
IAllowRESTExecution

An IAllowRESTExecution for executing the action.

ToGPALObject()

Declaration
public RESTClient ToGPALObject()
Returns
Type Description
RESTClient

While(Func<Boolean>)

Declaration
public IAllowRESTParametersOrExecution While(Func<bool> condition)
Parameters
Type Name Description
System.Func<System.Boolean> condition
Returns
Type Description
IAllowRESTParametersOrExecution

WithAPIBase(String)

Declaration
public IAllowRESTEndpointDetails WithAPIBase(string url)
Parameters
Type Name Description
System.String url
Returns
Type Description
IAllowRESTEndpointDetails

WithAPIBase(String, String)

Declaration
public IAllowRESTEndpointDetails WithAPIBase(string url, string downloadPath)
Parameters
Type Name Description
System.String url
System.String downloadPath
Returns
Type Description
IAllowRESTEndpointDetails

WithCss(String)

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

WithCssFromResult(Int32)

Declaration
public IAllowRESTExecution WithCssFromResult(int resultIndex)
Parameters
Type Name Description
System.Int32 resultIndex
Returns
Type Description
IAllowRESTExecution

WithCssFromResult(String)

Declaration
public IAllowRESTExecution WithCssFromResult(string name)
Parameters
Type Name Description
System.String name
Returns
Type Description
IAllowRESTExecution

WithElement(String)

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

WithElementFromResult(Int32)

Declaration
public IAllowRESTExecution WithElementFromResult(int resultIndex)
Parameters
Type Name Description
System.Int32 resultIndex
Returns
Type Description
IAllowRESTExecution

WithElementFromResult(String)

Declaration
public IAllowRESTExecution WithElementFromResult(string name)
Parameters
Type Name Description
System.String name
Returns
Type Description
IAllowRESTExecution

WithEndpoint(Enums.ApiEndpoint)

Declaration
public IAllowRESTParametersOrExecution WithEndpoint(Enums.ApiEndpoint endpoint)
Parameters
Type Name Description
Enums.ApiEndpoint endpoint
Returns
Type Description
IAllowRESTParametersOrExecution

WithEndpoint(String)

Declaration
public IAllowRESTParametersOrExecution WithEndpoint(string endpoint)
Parameters
Type Name Description
System.String endpoint
Returns
Type Description
IAllowRESTParametersOrExecution

WithHttpMethod(String)

Declaration
public IAllowRESTExecution WithHttpMethod(string method)
Parameters
Type Name Description
System.String method
Returns
Type Description
IAllowRESTExecution

WithKey(String)

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

WithKeyFromResult(Int32)

Declaration
public IAllowRESTExecution WithKeyFromResult(int resultIndex)
Parameters
Type Name Description
System.Int32 resultIndex
Returns
Type Description
IAllowRESTExecution

WithKeyFromResult(String)

Declaration
public IAllowRESTExecution WithKeyFromResult(string name)
Parameters
Type Name Description
System.String name
Returns
Type Description
IAllowRESTExecution

WithMaxConnections(Int32)

Declaration
public IAllowCheckNetworkIdleOrExecution WithMaxConnections(int maxConnections)
Parameters
Type Name Description
System.Int32 maxConnections
Returns
Type Description
IAllowCheckNetworkIdleOrExecution

WithName(String)

Declaration
public IAllowRESTEndpointDetails WithName(string name)
Parameters
Type Name Description
System.String name
Returns
Type Description
IAllowRESTEndpointDetails

WithParameters(Object)

Declaration
public IAllowRESTScript WithParameters(object parameters)
Parameters
Type Name Description
System.Object parameters
Returns
Type Description
IAllowRESTScript

WithParameters(Object[])

Declaration
public IAllowRESTScript WithParameters(params object[] parameters)
Parameters
Type Name Description
System.Object[] parameters
Returns
Type Description
IAllowRESTScript

WithParametersFromResult(Int32)

Declaration
public IAllowRESTScript WithParametersFromResult(int resultIndex)
Parameters
Type Name Description
System.Int32 resultIndex
Returns
Type Description
IAllowRESTScript

WithParametersFromResult(String)

Declaration
public IAllowRESTScript WithParametersFromResult(string name)
Parameters
Type Name Description
System.String name
Returns
Type Description
IAllowRESTScript

WithPixels(Int32)

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

WithPixelsFromResult(Int32)

Declaration
public IAllowRESTExecution WithPixelsFromResult(int resultIndex)
Parameters
Type Name Description
System.Int32 resultIndex
Returns
Type Description
IAllowRESTExecution

WithPixelsFromResult(String)

Declaration
public IAllowRESTExecution WithPixelsFromResult(string name)
Parameters
Type Name Description
System.String name
Returns
Type Description
IAllowRESTExecution

WithPruneMs(Int32)

Declaration
public IAllowCheckNetworkIdleOrExecution WithPruneMs(int pruneMs)
Parameters
Type Name Description
System.Int32 pruneMs
Returns
Type Description
IAllowCheckNetworkIdleOrExecution

WithReferrer(String)

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

WithReferrerFromResult(Int32)

Declaration
public IAllowRESTExecution WithReferrerFromResult(int resultIndex)
Parameters
Type Name Description
System.Int32 resultIndex
Returns
Type Description
IAllowRESTExecution

WithReferrerFromResult(String)

Declaration
public IAllowRESTExecution WithReferrerFromResult(string name)
Parameters
Type Name Description
System.String name
Returns
Type Description
IAllowRESTExecution

WithResultName(String)

Declaration
public IAllowRESTParametersOrExecution WithResultName(string name)
Parameters
Type Name Description
System.String name
Returns
Type Description
IAllowRESTParametersOrExecution

WithScript(String)

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

WithTabId(Int32)

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

WithTabIdFromResult(Int32)

Declaration
public IAllowRESTExecution WithTabIdFromResult(int resultIndex)
Parameters
Type Name Description
System.Int32 resultIndex
Returns
Type Description
IAllowRESTExecution

WithTabIdFromResult(String)

Declaration
public IAllowRESTExecution WithTabIdFromResult(string name)
Parameters
Type Name Description
System.String name
Returns
Type Description
IAllowRESTExecution

WithText(String)

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

WithTextFromResult(Int32)

Declaration
public IAllowRESTExecution WithTextFromResult(int resultIndex)
Parameters
Type Name Description
System.Int32 resultIndex
Returns
Type Description
IAllowRESTExecution

WithTextFromResult(String)

Declaration
public IAllowRESTExecution WithTextFromResult(string name)
Parameters
Type Name Description
System.String name
Returns
Type Description
IAllowRESTExecution

WithTimeoutMs(Int32)

Declaration
public IAllowCheckNetworkIdleOrExecution WithTimeoutMs(int timeoutMs)
Parameters
Type Name Description
System.Int32 timeoutMs
Returns
Type Description
IAllowCheckNetworkIdleOrExecution

WithUrl(String)

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

WithUrlFromResult(Int32)

Declaration
public IAllowRESTExecution WithUrlFromResult(int resultIndex)
Parameters
Type Name Description
System.Int32 resultIndex
Returns
Type Description
IAllowRESTExecution

WithUrlFromResult(String)

Declaration
public IAllowRESTExecution WithUrlFromResult(string name)
Parameters
Type Name Description
System.String name
Returns
Type Description
IAllowRESTExecution

WithWorkflow(Action<RESTClient>)

Declaration
public IAllowRESTWorkflow WithWorkflow(Action<RESTClient> workflow)
Parameters
Type Name Description
System.Action<RESTClient> workflow
Returns
Type Description
IAllowRESTWorkflow

WithXPath(String)

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

WithXPathFromResult(Int32)

Declaration
public IAllowRESTExecution WithXPathFromResult(int resultIndex)
Parameters
Type Name Description
System.Int32 resultIndex
Returns
Type Description
IAllowRESTExecution

WithXPathFromResult(String)

Declaration
public IAllowRESTExecution WithXPathFromResult(string name)
Parameters
Type Name Description
System.String name
Returns
Type Description
IAllowRESTExecution

Implements