FSharp.Data


Http Type

Utilities for working with network via HTTP. Includes methods for downloading resources with specified headers, query parameters and HTTP body

Static members

Static member Description

Http.AsyncRequest(url, ?query, ?headers, ?httpMethod, ?body, ?cookies, ?cookieContainer, ?silentHttpErrors, ?silentCookieErrors, ?responseEncodingOverride, ?customizeHttpRequest, ?timeout)

Full Usage: Http.AsyncRequest(url, ?query, ?headers, ?httpMethod, ?body, ?cookies, ?cookieContainer, ?silentHttpErrors, ?silentCookieErrors, ?responseEncodingOverride, ?customizeHttpRequest, ?timeout)

Parameters:
    url : string
    ?query : (string * string) list
    ?headers : seq<string * string>
    ?httpMethod : string
    ?body : HttpRequestBody
    ?cookies : seq<string * string>
    ?cookieContainer : CookieContainer
    ?silentHttpErrors : bool
    ?silentCookieErrors : bool
    ?responseEncodingOverride : string
    ?customizeHttpRequest : HttpWebRequest -> HttpWebRequest
    ?timeout : int

Returns: Async<HttpResponse>

Download an HTTP web resource from the specified URL asynchronously (allows specifying query string parameters and HTTP headers including headers that have to be handled specially - such as Accept, Content-Type & Referer) The body for POST request can be specified either as text or as a list of parameters that will be encoded, and the method will automatically be set if not specified

url : string
?query : (string * string) list
?headers : seq<string * string>
?httpMethod : string
?body : HttpRequestBody
?cookies : seq<string * string>
?cookieContainer : CookieContainer
?silentHttpErrors : bool
?silentCookieErrors : bool
?responseEncodingOverride : string
?customizeHttpRequest : HttpWebRequest -> HttpWebRequest
?timeout : int
Returns: Async<HttpResponse>

Http.AsyncRequestStream(url, ?query, ?headers, ?httpMethod, ?body, ?cookies, ?cookieContainer, ?silentHttpErrors, ?silentCookieErrors, ?customizeHttpRequest, ?timeout)

Full Usage: Http.AsyncRequestStream(url, ?query, ?headers, ?httpMethod, ?body, ?cookies, ?cookieContainer, ?silentHttpErrors, ?silentCookieErrors, ?customizeHttpRequest, ?timeout)

Parameters:
    url : string
    ?query : (string * string) list
    ?headers : seq<string * string>
    ?httpMethod : string
    ?body : HttpRequestBody
    ?cookies : seq<string * string>
    ?cookieContainer : CookieContainer
    ?silentHttpErrors : bool
    ?silentCookieErrors : bool
    ?customizeHttpRequest : HttpWebRequest -> HttpWebRequest
    ?timeout : int

Returns: Async<HttpResponseWithStream>

Download an HTTP web resource from the specified URL asynchronously (allows specifying query string parameters and HTTP headers including headers that have to be handled specially - such as Accept, Content-Type & Referer) The body for POST request can be specified either as text or as a list of parameters that will be encoded, and the method will automatically be set if not specified

url : string
?query : (string * string) list
?headers : seq<string * string>
?httpMethod : string
?body : HttpRequestBody
?cookies : seq<string * string>
?cookieContainer : CookieContainer
?silentHttpErrors : bool
?silentCookieErrors : bool
?customizeHttpRequest : HttpWebRequest -> HttpWebRequest
?timeout : int
Returns: Async<HttpResponseWithStream>

Http.AsyncRequestString(url, ?query, ?headers, ?httpMethod, ?body, ?cookies, ?cookieContainer, ?silentHttpErrors, ?silentCookieErrors, ?responseEncodingOverride, ?customizeHttpRequest, ?timeout)

Full Usage: Http.AsyncRequestString(url, ?query, ?headers, ?httpMethod, ?body, ?cookies, ?cookieContainer, ?silentHttpErrors, ?silentCookieErrors, ?responseEncodingOverride, ?customizeHttpRequest, ?timeout)

Parameters:
    url : string
    ?query : (string * string) list
    ?headers : seq<string * string>
    ?httpMethod : string
    ?body : HttpRequestBody
    ?cookies : seq<string * string>
    ?cookieContainer : CookieContainer
    ?silentHttpErrors : bool
    ?silentCookieErrors : bool
    ?responseEncodingOverride : string
    ?customizeHttpRequest : HttpWebRequest -> HttpWebRequest
    ?timeout : int

Returns: Async<string>

Download an HTTP web resource from the specified URL asynchronously (allows specifying query string parameters and HTTP headers including headers that have to be handled specially - such as Accept, Content-Type & Referer) The body for POST request can be specified either as text or as a list of parameters that will be encoded, and the method will automatically be set if not specified

url : string
?query : (string * string) list
?headers : seq<string * string>
?httpMethod : string
?body : HttpRequestBody
?cookies : seq<string * string>
?cookieContainer : CookieContainer
?silentHttpErrors : bool
?silentCookieErrors : bool
?responseEncodingOverride : string
?customizeHttpRequest : HttpWebRequest -> HttpWebRequest
?timeout : int
Returns: Async<string>

Http.Request(url, ?query, ?headers, ?httpMethod, ?body, ?cookies, ?cookieContainer, ?silentHttpErrors, ?silentCookieErrors, ?responseEncodingOverride, ?customizeHttpRequest, ?timeout)

Full Usage: Http.Request(url, ?query, ?headers, ?httpMethod, ?body, ?cookies, ?cookieContainer, ?silentHttpErrors, ?silentCookieErrors, ?responseEncodingOverride, ?customizeHttpRequest, ?timeout)

Parameters:
    url : string
    ?query : (string * string) list
    ?headers : seq<string * string>
    ?httpMethod : string
    ?body : HttpRequestBody
    ?cookies : seq<string * string>
    ?cookieContainer : CookieContainer
    ?silentHttpErrors : bool
    ?silentCookieErrors : bool
    ?responseEncodingOverride : string
    ?customizeHttpRequest : HttpWebRequest -> HttpWebRequest
    ?timeout : int

Returns: HttpResponse

Download an HTTP web resource from the specified URL synchronously (allows specifying query string parameters and HTTP headers including headers that have to be handled specially - such as Accept, Content-Type & Referer) The body for POST request can be specified either as text or as a list of parameters that will be encoded, and the method will automatically be set if not specified

url : string
?query : (string * string) list
?headers : seq<string * string>
?httpMethod : string
?body : HttpRequestBody
?cookies : seq<string * string>
?cookieContainer : CookieContainer
?silentHttpErrors : bool
?silentCookieErrors : bool
?responseEncodingOverride : string
?customizeHttpRequest : HttpWebRequest -> HttpWebRequest
?timeout : int
Returns: HttpResponse

Http.RequestStream(url, ?query, ?headers, ?httpMethod, ?body, ?cookies, ?cookieContainer, ?silentHttpErrors, ?silentCookieErrors, ?customizeHttpRequest, ?timeout)

Full Usage: Http.RequestStream(url, ?query, ?headers, ?httpMethod, ?body, ?cookies, ?cookieContainer, ?silentHttpErrors, ?silentCookieErrors, ?customizeHttpRequest, ?timeout)

Parameters:
    url : string
    ?query : (string * string) list
    ?headers : seq<string * string>
    ?httpMethod : string
    ?body : HttpRequestBody
    ?cookies : seq<string * string>
    ?cookieContainer : CookieContainer
    ?silentHttpErrors : bool
    ?silentCookieErrors : bool
    ?customizeHttpRequest : HttpWebRequest -> HttpWebRequest
    ?timeout : int

Returns: HttpResponseWithStream

Download an HTTP web resource from the specified URL synchronously (allows specifying query string parameters and HTTP headers including headers that have to be handled specially - such as Accept, Content-Type & Referer) The body for POST request can be specified either as text or as a list of parameters that will be encoded, and the method will automatically be set if not specified

url : string
?query : (string * string) list
?headers : seq<string * string>
?httpMethod : string
?body : HttpRequestBody
?cookies : seq<string * string>
?cookieContainer : CookieContainer
?silentHttpErrors : bool
?silentCookieErrors : bool
?customizeHttpRequest : HttpWebRequest -> HttpWebRequest
?timeout : int
Returns: HttpResponseWithStream

Http.RequestString(url, ?query, ?headers, ?httpMethod, ?body, ?cookies, ?cookieContainer, ?silentHttpErrors, ?silentCookieErrors, ?responseEncodingOverride, ?customizeHttpRequest, ?timeout)

Full Usage: Http.RequestString(url, ?query, ?headers, ?httpMethod, ?body, ?cookies, ?cookieContainer, ?silentHttpErrors, ?silentCookieErrors, ?responseEncodingOverride, ?customizeHttpRequest, ?timeout)

Parameters:
    url : string
    ?query : (string * string) list
    ?headers : seq<string * string>
    ?httpMethod : string
    ?body : HttpRequestBody
    ?cookies : seq<string * string>
    ?cookieContainer : CookieContainer
    ?silentHttpErrors : bool
    ?silentCookieErrors : bool
    ?responseEncodingOverride : string
    ?customizeHttpRequest : HttpWebRequest -> HttpWebRequest
    ?timeout : int

Returns: string

Download an HTTP web resource from the specified URL synchronously (allows specifying query string parameters and HTTP headers including headers that have to be handled specially - such as Accept, Content-Type & Referer) The body for POST request can be specified either as text or as a list of parameters that will be encoded, and the method will automatically be set if not specified

url : string
?query : (string * string) list
?headers : seq<string * string>
?httpMethod : string
?body : HttpRequestBody
?cookies : seq<string * string>
?cookieContainer : CookieContainer
?silentHttpErrors : bool
?silentCookieErrors : bool
?responseEncodingOverride : string
?customizeHttpRequest : HttpWebRequest -> HttpWebRequest
?timeout : int
Returns: string