Request Headers

HttpBuildR provides a set of methods to modify the headers of an HttpRequestMessage object in a fluent manner.

WithHeader Method

The WithHeader method adds a header to the request.

Usage:

HttpRequestMessage request = new HttpRequestMessage();
request = request.WithHeader("headerName", "headerValue");

Name	Value
headerName	headerValue

WithAuthorization Method

The WithAuthorization method adds an authentication header.

Usage:

HttpRequestMessage request = new HttpRequestMessage();
request = request.WithAuthorization("scheme", "parameter");

Name	Value
Authorization	scheme parameter

WithProxyAuthorization Method

The WithProxyAuthorization method adds a Proxy-Authorization header.

Usage:

HttpRequestMessage request = new HttpRequestMessage();
request = request.WithProxyAuthorization("scheme", "parameter");

Name	Value
Proxy-Authorization	scheme parameter

WithBearerToken Method

The WithBearerToken method adds a Bearer authentication token header.

Usage:

HttpRequestMessage request = new HttpRequestMessage();
request = request.WithBearerToken("token");

Name	Value
Authorization	Bearer token

WithBasicToken Method

The WithBasicToken method adds a Basic authentication token header.

Usage:

HttpRequestMessage request = new HttpRequestMessage();
request = request.WithBasicToken("token");

Name	Value
Authorization	Basic token

WithCacheControl Method

The WithCacheControl method adds a cache control header.

Usage:

HttpRequestMessage request = new HttpRequestMessage();
request = request.WithCacheControl(new CacheControlHeaderValue { NoCache = true });

Name	Value
Cache-Control	no-cache

WithConnectionClose Method

The WithConnectionClose method adds a connection closed header.

Usage:

HttpRequestMessage request = new HttpRequestMessage();
request = request.WithConnectionClose(true);

Name	Value
Connection	close

WithDate Method

The WithDate method adds a date header.

Usage:

HttpRequestMessage request = new HttpRequestMessage();
request = request.WithDate(new DateTimeOffset(2021, 1, 1, 0, 0, 0, TimeSpan.Zero));

Name	Value
Date	Fri, 01 Jan 2021 00:00:00 GMT

WithAccept Method

The WithAccept method adds to the accept content type header.

Usage:

HttpRequestMessage request = new HttpRequestMessage();
request = request.WithAccept("application/json");

Name	Value
Accept	application/json

WithIfModifiedSince Method

The WithIfModifiedSince method adds a If-Modified-Since header.

Usage:

HttpRequestMessage request = new HttpRequestMessage();
request = request.WithIfModifiedSince(
    new DateTimeOffset(2021, 1, 1, 0, 0, 0, TimeSpan.Zero)
);

Name	Value
If-Modified-Since	Fri, 01 Jan 2021 00:00:00 GMT

WithIfRange Method

The WithIfRange method adds a If-Range header.

Usage:

HttpRequestMessage request = new HttpRequestMessage();
request = request.WithIfRange(new EntityTagHeaderValue("\"tag\""));

Name	Value
If-Range	"tag"

WithIfUnmodifiedSince Method

The WithIfUnmodifiedSince method adds a If-Unmodified-Since header.

Usage:

HttpRequestMessage request = new HttpRequestMessage();
request = request.WithIfUnmodifiedSince(
    new DateTimeOffset(2021, 1, 1, 0, 0, 0, TimeSpan.Zero)
);

Name	Value
If-Unmodified-Since	Fri, 01 Jan 2021 00:00:00 GMT

WithMaxForwards Method

The WithMaxForwards method adds a Max-Forwards header.

Usage:

HttpRequestMessage request = new HttpRequestMessage();
request = request.WithMaxForwards(10);

Name	Value
Max-Forwards	10

WithRange Method

The WithRange method adds a Range header.

Usage:

HttpRequestMessage request = new HttpRequestMessage();
request = request.WithRange(0, 500);

Name	Value
Range	bytes=0-500

WithReferrer Method

The WithReferrer method adds a Referer header.

Usage:

HttpRequestMessage request = new HttpRequestMessage();
request = request.WithReferrer("https://example.com");

Name	Value
Referer	https://example.com/

WithTransferEncodingChunked Method

The WithTransferEncodingChunked method adds a Transfer-Encoding header.

Usage:

HttpRequestMessage request = new HttpRequestMessage();
request = request.WithTransferEncodingChunked(true);

Name	Value
Transfer-Encoding	chunked