Class ApiRequestBase

Defines the shared members of a request builder abstraction for a RESTful HTTP API.

Inheritance
Object
HttpRequestMessageBuilder
ApiRequestBase
ApiRequest
ApiRequest<T1>
ApiRequest<T1, T2>
ApiRequest<T1, T2, T3>
ApiRequest<T1, T2, T3, T4>
ApiRequest<T1, T2, T3, T4, T5>
ApiRequest<T1, T2, T3, T4, T5, T6>
ApiRequest<T1, T2, T3, T4, T5, T6, T7>
ApiRequest<T1, T2, T3, T4, T5, T6, T7, T8>
Namespace: ReqRest
Assembly: ReqRest.dll
Syntax
public abstract class ApiRequestBase : HttpRequestMessageBuilder, IHttpRequestMessageBuilder, IHttpHeadersBuilder<HttpRequestHeaders>, IHttpHeadersBuilder, IHttpRequestPropertiesBuilder, IHttpContentBuilder, IHttpProtocolVersionBuilder, IRequestUriBuilder, IHttpMethodBuilder, IBuilder

Constructors

ApiRequestBase(Func<HttpClient>, Nullable<HttpRequestMessage>)

Initializes a new ApiRequestBase instance with the specified initial property values.

Declaration
public ApiRequestBase(Func<HttpClient> httpClientProvider, HttpRequestMessage? httpRequestMessage = default(HttpRequestMessage? ))
Parameters
Type Name Description
Func<HttpClient> httpClientProvider

A function which returns an HttpClient instance which will ultimately be used to send the HttpRequestMessage for executing the API request.
Nullable<HttpRequestMessage> httpRequestMessage

The request from which the builder starts building. If null, a new instance is created instead.
Exceptions
Type Condition
ArgumentNullException
  • httpClientProvider

Properties

HttpClientProvider

Gets or sets a function which returns an HttpClient instance which will ultimately be used to send the HttpRequestMessage for executing the API request.

Declaration
public Func<HttpClient> HttpClientProvider { get; set; }
Exceptions
Type Condition
ArgumentNullException

PossibleResponseTypes

Gets a list of elements which declare what possible .NET types the API may return for this request, depending on the result's status code.

Declaration
public IReadOnlyCollection<ResponseTypeInfo> PossibleResponseTypes { get; }

Implements

Extension Methods