Show / Hide Table of Contents

Class Browser

Headless browser implimentation that creates documents for each web request.

Inheritance
System.Object
Browser
Implements
IBrowser
Inherited Members
System.Object.Equals(System.Object)
System.Object.Equals(System.Object, System.Object)
System.Object.GetHashCode()
System.Object.GetType()
System.Object.MemberwiseClone()
System.Object.ReferenceEquals(System.Object, System.Object)
System.Object.ToString()
Namespace: BrowseSharp
Assembly: BrowseSharp.dll
Syntax
public class Browser : IBrowser

Constructors

| Improve this Doc View Source

Browser()

Default Constructor

Declaration
public Browser()

Properties

| Improve this Doc View Source

Authenticator

Authenticator to be used by client

Declaration
public IAuthenticator Authenticator { get; set; }
Property Value
Type Description
RestSharp.Authenticators.IAuthenticator
| Improve this Doc View Source

AutomaticDecompression

Automatic decompression attribute for client

Declaration
public bool AutomaticDecompression { get; set; }
Property Value
Type Description
System.Boolean
| Improve this Doc View Source

BaseHost

Base host for client

Declaration
public string BaseHost { get; set; }
Property Value
Type Description
System.String
| Improve this Doc View Source

BaseUrl

Base url for client that is used for each request

Declaration
public Uri BaseUrl { get; set; }
Property Value
Type Description
System.Uri
| Improve this Doc View Source

CachePolicy

Request cache policy for client

Declaration
public RequestCachePolicy CachePolicy { get; set; }
Property Value
Type Description
System.Net.Cache.RequestCachePolicy
| Improve this Doc View Source

ClientCertificates

X509Certificates for client

Declaration
public X509CertificateCollection ClientCertificates { get; set; }
Property Value
Type Description
System.Security.Cryptography.X509Certificates.X509CertificateCollection
| Improve this Doc View Source

CookieContainer

Cookie container containing cookies

Declaration
public CookieContainer CookieContainer { get; set; }
Property Value
Type Description
System.Net.CookieContainer
| Improve this Doc View Source

DefaultParameters

Default parameters for client

Declaration
public IList<Parameter> DefaultParameters { get; }
Property Value
Type Description
System.Collections.Generic.IList<RestSharp.Parameter>
| Improve this Doc View Source

Documents

List of documents stored from each request made

Declaration
public List<IDocument> Documents { get; }
Property Value
Type Description
System.Collections.Generic.List<IDocument>
| Improve this Doc View Source

Encoding

Encoding for client request

Declaration
public Encoding Encoding { get; set; }
Property Value
Type Description
System.Text.Encoding
| Improve this Doc View Source

FollowRedirects

Follow Redirects attribute for client

Declaration
public bool FollowRedirects { get; set; }
Property Value
Type Description
System.Boolean
| Improve this Doc View Source

JavascriptEngine

Javascript engine used by browser

Declaration
public JavascriptEngine JavascriptEngine { get; }
Property Value
Type Description
JavascriptEngine
| Improve this Doc View Source

MaxRedirects

Max number of redirects to be taken for a request

Declaration
public int? MaxRedirects { get; set; }
Property Value
Type Description
System.Nullable<System.Int32>
| Improve this Doc View Source

Pipelined

Pipelined attribute for client

Declaration
public bool Pipelined { get; set; }
Property Value
Type Description
System.Boolean
| Improve this Doc View Source

PreAuthenticate

Pre-Authenticate parameter for client

Declaration
public bool PreAuthenticate { get; set; }
Property Value
Type Description
System.Boolean
| Improve this Doc View Source

Proxy

Proxy for client

Declaration
public IWebProxy Proxy { get; set; }
Property Value
Type Description
System.Net.IWebProxy
| Improve this Doc View Source

ReadWriteTimeout

Read write timeout for client

Declaration
public int ReadWriteTimeout { get; set; }
Property Value
Type Description
System.Int32
| Improve this Doc View Source

RemoteCertificateValidationCallback

Remote certification validation callback for client

Declaration
public RemoteCertificateValidationCallback RemoteCertificateValidationCallback { get; set; }
Property Value
Type Description
System.Net.Security.RemoteCertificateValidationCallback
| Improve this Doc View Source

StyleEngine

Style engine for parsing css styles

Declaration
public StyleEngine StyleEngine { get; }
Property Value
Type Description
StyleEngine
| Improve this Doc View Source

Timeout

Timeout for client

Declaration
public int Timeout { get; set; }
Property Value
Type Description
System.Int32
| Improve this Doc View Source

UserAgent

User agent that client should send in request

Declaration
public string UserAgent { get; set; }
Property Value
Type Description
System.String
| Improve this Doc View Source

UseSynchronizationContext

Use synchronization context attribute for client

Declaration
public bool UseSynchronizationContext { get; set; }
Property Value
Type Description
System.Boolean

Methods

| Improve this Doc View Source

AddHandler(String, IDeserializer)

Adds handler for client

Declaration
public void AddHandler(string contentType, IDeserializer deserializer)
Parameters
Type Name Description
System.String contentType
RestSharp.Deserializers.IDeserializer deserializer
| Improve this Doc View Source

BuildUri(IRestRequest)

Helper for building uri for client

Declaration
public Uri BuildUri(IRestRequest request)
Parameters
Type Name Description
RestSharp.IRestRequest request
Returns
Type Description
System.Uri
| Improve this Doc View Source

ClearHandlers()

Clears all handlers for client

Declaration
public void ClearHandlers()
| Improve this Doc View Source

Deserialize<T>(IRestResponse)

Deserialize method for client

Declaration
public IRestResponse<T> Deserialize<T>(IRestResponse response)
Parameters
Type Name Description
RestSharp.IRestResponse response
Returns
Type Description
RestSharp.IRestResponse<T>
Type Parameters
Name Description
T
| Improve this Doc View Source

DownloadData(IRestRequest)

Downloads data from response

Declaration
public byte[] DownloadData(IRestRequest request)
Parameters
Type Name Description
RestSharp.IRestRequest request
Returns
Type Description
System.Byte[]
| Improve this Doc View Source

Execute(IRestRequest)

Executes a request

Declaration
public IDocument Execute(IRestRequest request)
Parameters
Type Name Description
RestSharp.IRestRequest request
Returns
Type Description
IDocument
| Improve this Doc View Source

ExecuteAsGet(IRestRequest, String)

Executes get request

Declaration
public IDocument ExecuteAsGet(IRestRequest request, string httpMethod)
Parameters
Type Name Description
RestSharp.IRestRequest request
System.String httpMethod
Returns
Type Description
IDocument
| Improve this Doc View Source

ExecuteAsPost(IRestRequest, String)

Executes post request

Declaration
public IDocument ExecuteAsPost(IRestRequest request, string httpMethod)
Parameters
Type Name Description
RestSharp.IRestRequest request
System.String httpMethod
Returns
Type Description
IDocument
| Improve this Doc View Source

ExecuteGetTaskAsync(IRestRequest)

Executes get request asynchronously

Declaration
public Task<IDocument> ExecuteGetTaskAsync(IRestRequest request)
Parameters
Type Name Description
RestSharp.IRestRequest request
Returns
Type Description
System.Threading.Tasks.Task<IDocument>
| Improve this Doc View Source

ExecuteGetTaskAsync(IRestRequest, CancellationToken)

Executes get request asynchronously

Declaration
public Task<IDocument> ExecuteGetTaskAsync(IRestRequest request, CancellationToken token)
Parameters
Type Name Description
RestSharp.IRestRequest request
System.Threading.CancellationToken token
Returns
Type Description
System.Threading.Tasks.Task<IDocument>
| Improve this Doc View Source

ExecutePostTaskAsync(IRestRequest)

Executes post request asynchronously

Declaration
public Task<IDocument> ExecutePostTaskAsync(IRestRequest request)
Parameters
Type Name Description
RestSharp.IRestRequest request
Returns
Type Description
System.Threading.Tasks.Task<IDocument>
| Improve this Doc View Source

ExecutePostTaskAsync(IRestRequest, CancellationToken)

Executes post request asynchronously

Declaration
public Task<IDocument> ExecutePostTaskAsync(IRestRequest request, CancellationToken token)
Parameters
Type Name Description
RestSharp.IRestRequest request
System.Threading.CancellationToken token
Returns
Type Description
System.Threading.Tasks.Task<IDocument>
| Improve this Doc View Source

ExecuteTaskAsync(IRestRequest)

Executes request asynchronously

Declaration
public Task<IDocument> ExecuteTaskAsync(IRestRequest request)
Parameters
Type Name Description
RestSharp.IRestRequest request
Returns
Type Description
System.Threading.Tasks.Task<IDocument>
| Improve this Doc View Source

ExecuteTaskAsync(IRestRequest, CancellationToken)

Executes request asynchronously

Declaration
public Task<IDocument> ExecuteTaskAsync(IRestRequest request, CancellationToken token)
Parameters
Type Name Description
RestSharp.IRestRequest request
System.Threading.CancellationToken token
Returns
Type Description
System.Threading.Tasks.Task<IDocument>
| Improve this Doc View Source

Navigate(String)

Performs get request

Declaration
public IDocument Navigate(string uri)
Parameters
Type Name Description
System.String uri
Returns
Type Description
IDocument
| Improve this Doc View Source

Navigate(String, Dictionary<String, String>)

Performs get request

Declaration
public IDocument Navigate(string uri, Dictionary<string, string> headers)
Parameters
Type Name Description
System.String uri
System.Collections.Generic.Dictionary<System.String, System.String> headers
Returns
Type Description
IDocument
| Improve this Doc View Source

Navigate(String, Dictionary<String, String>, Dictionary<String, String>)

Performs get request

Declaration
public IDocument Navigate(string uri, Dictionary<string, string> headers, Dictionary<string, string> formData)
Parameters
Type Name Description
System.String uri
System.Collections.Generic.Dictionary<System.String, System.String> headers
System.Collections.Generic.Dictionary<System.String, System.String> formData
Returns
Type Description
IDocument
| Improve this Doc View Source

Navigate(Uri)

Performs get request

Declaration
public IDocument Navigate(Uri uri)
Parameters
Type Name Description
System.Uri uri
Returns
Type Description
IDocument
| Improve this Doc View Source

Navigate(Uri, Dictionary<String, String>)

Performs get request

Declaration
public IDocument Navigate(Uri uri, Dictionary<string, string> headers)
Parameters
Type Name Description
System.Uri uri
System.Collections.Generic.Dictionary<System.String, System.String> headers
Returns
Type Description
IDocument
| Improve this Doc View Source

Navigate(Uri, Dictionary<String, String>, Dictionary<String, String>)

Performs get request

Declaration
public IDocument Navigate(Uri uri, Dictionary<string, string> headers, Dictionary<string, string> formData)
Parameters
Type Name Description
System.Uri uri
System.Collections.Generic.Dictionary<System.String, System.String> headers
System.Collections.Generic.Dictionary<System.String, System.String> formData
Returns
Type Description
IDocument
| Improve this Doc View Source

NavigateAsync(String)

Performs get request asynchronously

Declaration
public Task<IDocument> NavigateAsync(string uri)
Parameters
Type Name Description
System.String uri
Returns
Type Description
System.Threading.Tasks.Task<IDocument>
| Improve this Doc View Source

NavigateAsync(String, Dictionary<String, String>)

Performs get request asynchronously

Declaration
public Task<IDocument> NavigateAsync(string uri, Dictionary<string, string> headers)
Parameters
Type Name Description
System.String uri
System.Collections.Generic.Dictionary<System.String, System.String> headers
Returns
Type Description
System.Threading.Tasks.Task<IDocument>
| Improve this Doc View Source

NavigateAsync(String, Dictionary<String, String>, Dictionary<String, String>)

Performs get request asynchronously

Declaration
public Task<IDocument> NavigateAsync(string uri, Dictionary<string, string> headers, Dictionary<string, string> formData)
Parameters
Type Name Description
System.String uri
System.Collections.Generic.Dictionary<System.String, System.String> headers
System.Collections.Generic.Dictionary<System.String, System.String> formData
Returns
Type Description
System.Threading.Tasks.Task<IDocument>
| Improve this Doc View Source

NavigateAsync(Uri)

Performs get request asynchronously

Declaration
public Task<IDocument> NavigateAsync(Uri uri)
Parameters
Type Name Description
System.Uri uri
Returns
Type Description
System.Threading.Tasks.Task<IDocument>
| Improve this Doc View Source

NavigateAsync(Uri, Dictionary<String, String>)

Performs get request asynchronously

Declaration
public Task<IDocument> NavigateAsync(Uri uri, Dictionary<string, string> headers)
Parameters
Type Name Description
System.Uri uri
System.Collections.Generic.Dictionary<System.String, System.String> headers
Returns
Type Description
System.Threading.Tasks.Task<IDocument>
| Improve this Doc View Source

NavigateAsync(Uri, Dictionary<String, String>, Dictionary<String, String>)

Performs get request asynchronously

Declaration
public Task<IDocument> NavigateAsync(Uri uri, Dictionary<string, string> headers, Dictionary<string, string> formData)
Parameters
Type Name Description
System.Uri uri
System.Collections.Generic.Dictionary<System.String, System.String> headers
System.Collections.Generic.Dictionary<System.String, System.String> formData
Returns
Type Description
System.Threading.Tasks.Task<IDocument>
| Improve this Doc View Source

RemoveHandler(String)

Removes handler from client

Declaration
public void RemoveHandler(string contentType)
Parameters
Type Name Description
System.String contentType
| Improve this Doc View Source

Submit(String)

Performs a post request

Declaration
public IDocument Submit(string uri)
Parameters
Type Name Description
System.String uri
Returns
Type Description
IDocument
| Improve this Doc View Source

Submit(String, Dictionary<String, String>)

Performs a post request

Declaration
public IDocument Submit(string uri, Dictionary<string, string> formData)
Parameters
Type Name Description
System.String uri
System.Collections.Generic.Dictionary<System.String, System.String> formData
Returns
Type Description
IDocument
| Improve this Doc View Source

Submit(String, Dictionary<String, String>, Dictionary<String, String>)

Performs a post request

Declaration
public IDocument Submit(string uri, Dictionary<string, string> formData, Dictionary<string, string> headers)
Parameters
Type Name Description
System.String uri
System.Collections.Generic.Dictionary<System.String, System.String> formData
System.Collections.Generic.Dictionary<System.String, System.String> headers
Returns
Type Description
IDocument
| Improve this Doc View Source

Submit(Uri)

Performs a post request

Declaration
public IDocument Submit(Uri uri)
Parameters
Type Name Description
System.Uri uri
Returns
Type Description
IDocument
| Improve this Doc View Source

Submit(Uri, Dictionary<String, String>)

Performs a post request

Declaration
public IDocument Submit(Uri uri, Dictionary<string, string> formData)
Parameters
Type Name Description
System.Uri uri
System.Collections.Generic.Dictionary<System.String, System.String> formData
Returns
Type Description
IDocument
| Improve this Doc View Source

Submit(Uri, Dictionary<String, String>, Dictionary<String, String>)

Performs a post request

Declaration
public IDocument Submit(Uri uri, Dictionary<string, string> formData, Dictionary<string, string> headers)
Parameters
Type Name Description
System.Uri uri
System.Collections.Generic.Dictionary<System.String, System.String> formData
System.Collections.Generic.Dictionary<System.String, System.String> headers
Returns
Type Description
IDocument
| Improve this Doc View Source

SubmitAsync(String)

Performs a post request asynchronously

Declaration
public Task<IDocument> SubmitAsync(string uri)
Parameters
Type Name Description
System.String uri
Returns
Type Description
System.Threading.Tasks.Task<IDocument>
| Improve this Doc View Source

SubmitAsync(String, Dictionary<String, String>)

Performs a post request asynchronously

Declaration
public Task<IDocument> SubmitAsync(string uri, Dictionary<string, string> formData)
Parameters
Type Name Description
System.String uri
System.Collections.Generic.Dictionary<System.String, System.String> formData
Returns
Type Description
System.Threading.Tasks.Task<IDocument>
| Improve this Doc View Source

SubmitAsync(String, Dictionary<String, String>, Dictionary<String, String>)

Performs a post request asynchronously

Declaration
public Task<IDocument> SubmitAsync(string uri, Dictionary<string, string> formData, Dictionary<string, string> headers)
Parameters
Type Name Description
System.String uri
System.Collections.Generic.Dictionary<System.String, System.String> formData
System.Collections.Generic.Dictionary<System.String, System.String> headers
Returns
Type Description
System.Threading.Tasks.Task<IDocument>
| Improve this Doc View Source

SubmitAsync(Uri)

Performs a post request asynchronously

Declaration
public Task<IDocument> SubmitAsync(Uri uri)
Parameters
Type Name Description
System.Uri uri
Returns
Type Description
System.Threading.Tasks.Task<IDocument>
| Improve this Doc View Source

SubmitAsync(Uri, Dictionary<String, String>)

Performs a post request asynchronously

Declaration
public Task<IDocument> SubmitAsync(Uri uri, Dictionary<string, string> formData)
Parameters
Type Name Description
System.Uri uri
System.Collections.Generic.Dictionary<System.String, System.String> formData
Returns
Type Description
System.Threading.Tasks.Task<IDocument>
| Improve this Doc View Source

SubmitAsync(Uri, Dictionary<String, String>, Dictionary<String, String>)

Performs a post request asynchronously

Declaration
public Task<IDocument> SubmitAsync(Uri uri, Dictionary<string, string> formData, Dictionary<string, string> headers)
Parameters
Type Name Description
System.Uri uri
System.Collections.Generic.Dictionary<System.String, System.String> formData
System.Collections.Generic.Dictionary<System.String, System.String> headers
Returns
Type Description
System.Threading.Tasks.Task<IDocument>

Implements

IBrowser
  • Improve this Doc
  • View Source
Back to top Generated by DocFX