ReqRest
Show / Hide Table of Contents

Class HttpResponseMessageBuilder

Implements several builder interfaces which enable fluent building of HttpResponseMessage objects.

Inheritance
Object
HttpResponseMessageBuilder
ApiResponseBase
Implements
IHttpResponseMessageBuilder
IHttpHeadersBuilder<HttpResponseHeaders>
IHttpHeadersBuilder
IHttpContentBuilder
IHttpProtocolVersionBuilder
IHttpResponseReasonPhraseBuilder
IHttpStatusCodeBuilder
IBuilder
Namespace: ReqRest.Builders
Assembly: ReqRest.dll
Syntax
public class HttpResponseMessageBuilder : IHttpResponseMessageBuilder, IHttpHeadersBuilder<HttpResponseHeaders>, IHttpHeadersBuilder, IHttpContentBuilder, IHttpProtocolVersionBuilder, IHttpResponseReasonPhraseBuilder, IHttpStatusCodeBuilder, IBuilder

Constructors

HttpResponseMessageBuilder(Nullable<HttpResponseMessage>)

Initializes a new instance of the HttpResponseMessageBuilder class which starts building on the specified httpResponseMessage.

Declaration
public HttpResponseMessageBuilder(HttpResponseMessage? httpResponseMessage = default(HttpResponseMessage? ))
Parameters
Type Name Description
Nullable<HttpResponseMessage> httpResponseMessage

The response from which the builder starts building. If null, a new instance is created instead.

Properties

Content

Gets or sets the HTTP content of the HttpResponseMessage whose properties are being built.

Declaration
public HttpContent? Content { get; set; }

Headers

Gets the collection of HTTP response headers of the HttpResponseMessage whose properties are being built.

Declaration
public HttpResponseHeaders Headers { get; }

HttpResponseMessage

Gets or sets the HttpResponseMessage which is being built.

Declaration
public HttpResponseMessage HttpResponseMessage { get; set; }
Exceptions
Type Condition
ArgumentNullException

ReasonPhrase

Gets or sets the reason phrase of the HttpResponseMessage whose properties are being built.

Declaration
public string? ReasonPhrase { get; set; }

StatusCode

Gets or sets the HTTP status code of the HttpResponseMessage whose properties are being built.

Declaration
public HttpStatusCode StatusCode { get; set; }

Version

Gets or sets the HTTP message version of the HttpResponseMessage whose properties are being built.

Declaration
public Version Version { get; set; }

Methods

ToString()

Returns a string representing the values of the underlying HttpResponseMessage.

Declaration
public override string ToString()
Returns
Type Description
String

A string representing the values of the underlying HttpResponseMessage.

Overrides
Object.ToString()

Explicit Interface Implementations

IHttpHeadersBuilder.Headers

Gets the collection of HTTP headers which the builder builds.

Declaration
HttpHeaders IHttpHeadersBuilder.Headers { get; }
Returns
Type Description
HttpHeaders

Implements

IHttpResponseMessageBuilder
IHttpHeadersBuilder<T>
IHttpHeadersBuilder
IHttpContentBuilder
IHttpProtocolVersionBuilder
IHttpResponseReasonPhraseBuilder
IHttpStatusCodeBuilder
IBuilder

Extension Methods

JsonHttpContentBuilderExtensions.SetJsonContent<T>(T, Nullable<Object>, Nullable<Encoding>, Nullable<JsonHttpContentSerializer>)
BuilderExtensions.Configure<T>(T, Action<T>)
BuilderExtensions.If<T>(T, Boolean, Action<T>)
BuilderExtensions.IfNot<T>(T, Boolean, Action<T>)
HttpContentBuilderExtensions.SetFormUrlEncodedContent<T>(T, (String Key, String Value)[])
HttpContentBuilderExtensions.SetFormUrlEncodedContent<T>(T, IEnumerable<(String Key, String Value)>)
HttpContentBuilderExtensions.SetFormUrlEncodedContent<T>(T, KeyValuePair<String, String>[])
HttpContentBuilderExtensions.SetFormUrlEncodedContent<T>(T, IEnumerable<KeyValuePair<String, String>>)
HttpContentBuilderExtensions.SetContent<T>(T, String, Nullable<Encoding>, Nullable<String>)
HttpContentBuilderExtensions.SetContent<T>(T, Byte[])
HttpContentBuilderExtensions.SetContent<T>(T, Byte[], Int32, Int32)
HttpContentBuilderExtensions.SetContent<T>(T, Nullable<HttpContent>)
HttpContentBuilderExtensions.SetContentType<T>(T, String, Nullable<String>, Nullable<IEnumerable<NameValueHeaderValue>>)
HttpContentBuilderExtensions.SetContentType<T>(T, Nullable<MediaTypeHeaderValue>)
HttpContentBuilderExtensions.AddContentHeader<T>(T, String)
HttpContentBuilderExtensions.AddContentHeader<T>(T, String, Nullable<String>)
HttpContentBuilderExtensions.AddContentHeader<T>(T, String, Nullable<IEnumerable<Nullable<String>>>)
HttpContentBuilderExtensions.RemoveContentHeader<T>(T, Nullable<String>[], names)
HttpContentBuilderExtensions.ClearContentHeaders<T>(T)
HttpContentBuilderExtensions.ConfigureContentHeaders<T>(T, Action<HttpContentHeaders>)
HttpHeadersBuilderExtensions.AddHeader<T>(T, String)
HttpHeadersBuilderExtensions.AddHeader<T>(T, String, Nullable<String>)
HttpHeadersBuilderExtensions.AddHeader<T>(T, String, Nullable<IEnumerable<Nullable<String>>>)
HttpHeadersBuilderExtensions.RemoveHeader<T>(T, Nullable<String>[], names)
HttpHeadersBuilderExtensions.SetHeader<T>(T, String)
HttpHeadersBuilderExtensions.SetHeader<T>(T, String, Nullable<String>)
HttpHeadersBuilderExtensions.SetHeader<T>(T, String, Nullable<IEnumerable<Nullable<String>>>)
HttpHeadersBuilderExtensions.ClearHeaders<T>(T)
HttpHeadersBuilderExtensions.ConfigureHeaders<T>(T, Action<HttpHeaders>)
HttpProtocolVersionBuilderExtensions.SetVersion<T>(T, Version)
HttpResponseMessageBuilderExtensions.ConfigureResponse<T>(T, Action<HttpResponseMessage>)
HttpResponseMessageBuilderExtensions.ConfigureResponse<T>(T, Func<HttpResponseMessage>)
HttpResponseMessageBuilderExtensions.ConfigureResponse<T>(T, Func<HttpResponseMessage, HttpResponseMessage>)
HttpResponseMessageBuilderExtensions.SetResponse<T>(T, HttpResponseMessage)
HttpResponseReasonPhraseBuilderExtensions.SetReasonPhrase<T>(T, Nullable<String>)
HttpStatusCodeBuilderExtensions.SetStatusCode<T>(T, Int32)
HttpStatusCodeBuilderExtensions.SetStatusCode<T>(T, HttpStatusCode)
Back to top Copyright © 2019 ReqRest - Generated with DocFX - Material Theme made by Oscar Vásquez - Impressum (Imprint)