Header menu logo FsHttp

HeaderExtensions Type

Static members

Static member Description

HeaderExtensions.Accept(context, contentType)

Full Usage: HeaderExtensions.Accept(context, contentType)

Parameters:
Returns: HeaderContext

Content-Types that are acceptable for the response

context : HeaderContext
contentType : string
Returns: HeaderContext

HeaderExtensions.AcceptCharset(context, characterSets)

Full Usage: HeaderExtensions.AcceptCharset(context, characterSets)

Parameters:
Returns: HeaderContext

Character sets that are acceptable

context : HeaderContext
characterSets : string
Returns: HeaderContext

HeaderExtensions.AcceptDatetime(context, dateTime)

Full Usage: HeaderExtensions.AcceptDatetime(context, dateTime)

Parameters:
Returns: HeaderContext

Acceptable version in time

context : HeaderContext
dateTime : DateTime
Returns: HeaderContext

HeaderExtensions.AcceptEncoding(context, encoding)

Full Usage: HeaderExtensions.AcceptEncoding(context, encoding)

Parameters:
Returns: HeaderContext

List of acceptable encodings. See HTTP compression.

context : HeaderContext
encoding : string
Returns: HeaderContext

HeaderExtensions.AcceptLanguage(context, language)

Full Usage: HeaderExtensions.AcceptLanguage(context, language)

Parameters:
Returns: HeaderContext

List of acceptable human languages for response

context : HeaderContext
language : string
Returns: HeaderContext

HeaderExtensions.Authorization(context, credentials)

Full Usage: HeaderExtensions.Authorization(context, credentials)

Parameters:
Returns: HeaderContext

Authorization credentials for HTTP authorization

context : HeaderContext
credentials : string
Returns: HeaderContext

HeaderExtensions.AuthorizationBearer(context, token)

Full Usage: HeaderExtensions.AuthorizationBearer(context, token)

Parameters:
Returns: HeaderContext

Authorization header using Bearer authorization token

context : HeaderContext
token : string
Returns: HeaderContext

HeaderExtensions.AuthorizationUserPw(context, username, password)

Full Usage: HeaderExtensions.AuthorizationUserPw(context, username, password)

Parameters:
Returns: HeaderContext

Authorization header using Basic (User/Password) authorization

context : HeaderContext
username : string
password : string
Returns: HeaderContext

HeaderExtensions.CacheControl(context, control)

Full Usage: HeaderExtensions.CacheControl(context, control)

Parameters:
Returns: HeaderContext

Used to specify directives that MUST be obeyed by all caching mechanisms along the request/response chain

context : HeaderContext
control : string
Returns: HeaderContext

HeaderExtensions.Connection(context, connection)

Full Usage: HeaderExtensions.Connection(context, connection)

Parameters:
Returns: HeaderContext

What type of connection the user-agent would prefer

context : HeaderContext
connection : string
Returns: HeaderContext

HeaderExtensions.Date(context, date)

Full Usage: HeaderExtensions.Date(context, date)

Parameters:
Returns: HeaderContext

The date and time that the message was sent

context : HeaderContext
date : DateTime
Returns: HeaderContext

HeaderExtensions.Expect(context, behaviors)

Full Usage: HeaderExtensions.Expect(context, behaviors)

Parameters:
Returns: HeaderContext

Indicates that particular server behaviors are required by the client

context : HeaderContext
behaviors : string
Returns: HeaderContext

HeaderExtensions.Expires(context, dateTime)

Full Usage: HeaderExtensions.Expires(context, dateTime)

Parameters:
Returns: HeaderContext

Gives the date/time after which the response is considered stale

context : HeaderContext
dateTime : DateTime
Returns: HeaderContext

HeaderExtensions.From(context, email)

Full Usage: HeaderExtensions.From(context, email)

Parameters:
Returns: HeaderContext

The email address of the user making the request

context : HeaderContext
email : string
Returns: HeaderContext

HeaderExtensions.Header(context, key, value)

Full Usage: HeaderExtensions.Header(context, key, value)

Parameters:
Returns: HeaderContext

Custom header

context : HeaderContext
key : string
value : string
Returns: HeaderContext

HeaderExtensions.Host(context, host)

Full Usage: HeaderExtensions.Host(context, host)

Parameters:
Returns: HeaderContext

The domain name of the server (for virtual hosting), and the TCP port number on which the server is listening. The port number may be omitted if the port is the standard port for the service requested.

context : HeaderContext
host : string
Returns: HeaderContext

HeaderExtensions.IfMatch(context, entity)

Full Usage: HeaderExtensions.IfMatch(context, entity)

Parameters:
Returns: HeaderContext

Only perform the action if the client supplied entity matches the same entity on the server. This is mainly for methods like PUT to only update a resource if it has not been modified since the user last updated it. If-Match: "737060cd8c284d8af7ad3082f209582d" Permanent

context : HeaderContext
entity : string
Returns: HeaderContext

HeaderExtensions.IfModifiedSince(context, dateTime)

Full Usage: HeaderExtensions.IfModifiedSince(context, dateTime)

Parameters:
Returns: HeaderContext

Allows a 304 Not Modified to be returned if content is unchanged

context : HeaderContext
dateTime : DateTime
Returns: HeaderContext

HeaderExtensions.IfNoneMatch(context, etag)

Full Usage: HeaderExtensions.IfNoneMatch(context, etag)

Parameters:
Returns: HeaderContext

Allows a 304 Not Modified to be returned if content is unchanged

context : HeaderContext
etag : string
Returns: HeaderContext

HeaderExtensions.IfRange(context, range)

Full Usage: HeaderExtensions.IfRange(context, range)

Parameters:
Returns: HeaderContext

If the entity is unchanged, send me the part(s) that I am missing; otherwise, send me the entire new entity

context : HeaderContext
range : string
Returns: HeaderContext

HeaderExtensions.IfUnmodifiedSince(context, dateTime)

Full Usage: HeaderExtensions.IfUnmodifiedSince(context, dateTime)

Parameters:
Returns: HeaderContext

Only send the response if the entity has not been modified since a specific time

context : HeaderContext
dateTime : DateTime
Returns: HeaderContext

HeaderExtensions.KeepAlive(context, keepAlive)

Full Usage: HeaderExtensions.KeepAlive(context, keepAlive)

Parameters:
Returns: HeaderContext

Specifies a parameter used into order to maintain a persistent connection

context : HeaderContext
keepAlive : string
Returns: HeaderContext

HeaderExtensions.LastModified(context, dateTime)

Full Usage: HeaderExtensions.LastModified(context, dateTime)

Parameters:
Returns: HeaderContext

Specifies the date and time at which the accompanying body data was last modified

context : HeaderContext
dateTime : DateTime
Returns: HeaderContext

HeaderExtensions.MaxForwards(context, count)

Full Usage: HeaderExtensions.MaxForwards(context, count)

Parameters:
Returns: HeaderContext

Limit the number of times the message can be forwarded through proxies or gateways

context : HeaderContext
count : int
Returns: HeaderContext

HeaderExtensions.Origin(context, origin)

Full Usage: HeaderExtensions.Origin(context, origin)

Parameters:
Returns: HeaderContext

Initiates a request for cross-origin resource sharing (asks server for an 'Access-Control-Allow-Origin' response header)

context : HeaderContext
origin : string
Returns: HeaderContext

HeaderExtensions.Pragma(context, pragma)

Full Usage: HeaderExtensions.Pragma(context, pragma)

Parameters:
Returns: HeaderContext

Implementation-specific headers that may have various effects anywhere along the request-response chain.

context : HeaderContext
pragma : string
Returns: HeaderContext

HeaderExtensions.Prefer(context, prefer)

Full Usage: HeaderExtensions.Prefer(context, prefer)

Parameters:
Returns: HeaderContext

Optional instructions to the server to control request processing. See RFC https://tools.ietf.org/html/rfc7240 for more details

context : HeaderContext
prefer : string
Returns: HeaderContext

HeaderExtensions.ProxyAuthorization(context, credentials)

Full Usage: HeaderExtensions.ProxyAuthorization(context, credentials)

Parameters:
Returns: HeaderContext

Authorization credentials for connecting to a proxy.

context : HeaderContext
credentials : string
Returns: HeaderContext

HeaderExtensions.Query(context, queryParams)

Full Usage: HeaderExtensions.Query(context, queryParams)

Parameters:
Returns: HeaderContext

Append query params

context : HeaderContext
queryParams : (string * string) seq
Returns: HeaderContext

HeaderExtensions.Range(context, start, finish)

Full Usage: HeaderExtensions.Range(context, start, finish)

Parameters:
Returns: HeaderContext

Request only part of an entity. Bytes are numbered from 0

context : HeaderContext
start : int64
finish : int64
Returns: HeaderContext

HeaderExtensions.Referer(context, referer)

Full Usage: HeaderExtensions.Referer(context, referer)

Parameters:
Returns: HeaderContext

This is the address of the previous web page from which a link to the currently requested page was followed. (The word "referrer" is misspelled in the RFC as well as in most implementations.)

context : HeaderContext
referer : string
Returns: HeaderContext

HeaderExtensions.SetCookie(context, name, value)

Full Usage: HeaderExtensions.SetCookie(context, name, value)

Parameters:
Returns: HeaderContext

An HTTP cookie previously sent by the server with 'Set-Cookie'.

context : HeaderContext
name : string
value : string
Returns: HeaderContext

HeaderExtensions.SetCookieForDomain(context, name, value, path, domain)

Full Usage: HeaderExtensions.SetCookieForDomain(context, name, value, path, domain)

Parameters:
    context : HeaderContext
    name : string
    value : string
    path : string
    domain : string

Returns: HeaderContext

An HTTP cookie previously sent by the server with 'Set-Cookie' with the subset of URIs on the origin server to which this Cookie applies and the internet domain for which this Cookie is valid.

context : HeaderContext
name : string
value : string
path : string
domain : string
Returns: HeaderContext

HeaderExtensions.SetCookieForPath(context, name, value, path)

Full Usage: HeaderExtensions.SetCookieForPath(context, name, value, path)

Parameters:
    context : HeaderContext
    name : string
    value : string
    path : string

Returns: HeaderContext

An HTTP cookie previously sent by the server with 'Set-Cookie' with the subset of URIs on the origin server to which this Cookie applies.

context : HeaderContext
name : string
value : string
path : string
Returns: HeaderContext

HeaderExtensions.TE(context, te)

Full Usage: HeaderExtensions.TE(context, te)

Parameters:
Returns: HeaderContext

The transfer encodings the user agent is willing to accept: the same values as for the response header Transfer-Encoding can be used, plus the "trailers" value (related to the "chunked" transfer method) to notify the server it expects to receive additional headers (the trailers) after the last, zero-sized, chunk.

context : HeaderContext
te : string
Returns: HeaderContext

HeaderExtensions.Trailer(context, trailer)

Full Usage: HeaderExtensions.Trailer(context, trailer)

Parameters:
Returns: HeaderContext

The Trailer general field value indicates that the given set of header fields is present in the trailer of a message encoded with chunked transfer-coding

context : HeaderContext
trailer : string
Returns: HeaderContext

HeaderExtensions.TransferEncoding(context, directive)

Full Usage: HeaderExtensions.TransferEncoding(context, directive)

Parameters:
Returns: HeaderContext

The TransferEncoding header indicates the form of encoding used to safely transfer the entity to the user. The valid directives are one of: chunked, compress, deflate, gzip, orentity.

context : HeaderContext
directive : string
Returns: HeaderContext

HeaderExtensions.Translate(context, translate)

Full Usage: HeaderExtensions.Translate(context, translate)

Parameters:
Returns: HeaderContext

Microsoft extension to the HTTP specification used in conjunction with WebDAV functionality.

context : HeaderContext
translate : string
Returns: HeaderContext

HeaderExtensions.Upgrade(context, upgrade)

Full Usage: HeaderExtensions.Upgrade(context, upgrade)

Parameters:
Returns: HeaderContext

Specifies additional communications protocols that the client supports.

context : HeaderContext
upgrade : string
Returns: HeaderContext

HeaderExtensions.UserAgent(context, userAgent)

Full Usage: HeaderExtensions.UserAgent(context, userAgent)

Parameters:
Returns: HeaderContext

The user agent string of the user agent

context : HeaderContext
userAgent : string
Returns: HeaderContext

HeaderExtensions.Via(context, server)

Full Usage: HeaderExtensions.Via(context, server)

Parameters:
Returns: HeaderContext

Informs the server of proxies through which the request was sent

context : HeaderContext
server : string
Returns: HeaderContext

HeaderExtensions.Warning(context, message)

Full Usage: HeaderExtensions.Warning(context, message)

Parameters:
Returns: HeaderContext

A general warning about possible problems with the entity body

context : HeaderContext
message : string
Returns: HeaderContext

HeaderExtensions.XHTTPMethodOverride(context, httpMethod)

Full Usage: HeaderExtensions.XHTTPMethodOverride(context, httpMethod)

Parameters:
Returns: HeaderContext

Override HTTP method.

context : HeaderContext
httpMethod : string
Returns: HeaderContext

Type something to start searching.