Class ApiClientCommon

Namespace

VpnHood.Net.Toolkit.ApiClients

Assembly

VpnHood.Net.Toolkit.dll

Provides the base of a generated API client: the request's base address, authorization and headers, through the hooks the generated code calls.

public abstract class ApiClientCommon

Inheritance

object

ApiClientCommon

Derived

ApiClientBase

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Properties

DefaultAuthorization

Gets or sets the authorization a request without its own carries, or null for none.

public AuthenticationHeaderValue? DefaultAuthorization { get; set; }

Property Value

AuthenticationHeaderValue

DefaultBaseAddress

Gets or sets the address a relative request's URL is taken from, or null.

public Uri? DefaultBaseAddress { get; set; }

Property Value

Uri

DefaultHeaders

Gets or sets the headers every request carries. The default is none.

public Dictionary<string, string> DefaultHeaders { get; set; }

Property Value

Dictionary<string, string>

Methods

PrepareRequestAsync(HttpClient, HttpRequestMessage, string, CancellationToken)

Prepares a request before it is sent: sets its URL, on DefaultBaseAddress when relative, its DefaultAuthorization unless it has one, and the DefaultHeaders.

protected virtual Task PrepareRequestAsync(HttpClient client, HttpRequestMessage request, string url, CancellationToken cancellationToken)

Parameters

client HttpClient

The HTTP client.

request HttpRequestMessage

The request.

url string

The request's URL, absolute or relative.

cancellationToken CancellationToken

The token to monitor for cancellation requests.

Returns

Task

A task that represents the asynchronous operation.

PrepareRequestAsync(HttpClient, HttpRequestMessage, StringBuilder, CancellationToken)

Prepares a request before it is sent, as the URL-string overload does.

protected virtual Task PrepareRequestAsync(HttpClient client, HttpRequestMessage request, StringBuilder urlBuilder, CancellationToken cancellationToken)

Parameters

client HttpClient

The HTTP client.

request HttpRequestMessage

The request.

urlBuilder StringBuilder

The request's URL.

cancellationToken CancellationToken

The token to monitor for cancellation requests.

Returns

Task

A task that represents the asynchronous operation.

ProcessResponseAsync(HttpClient, HttpResponseMessage, CancellationToken)

Processes a response before it is read; the base does nothing.

protected virtual Task ProcessResponseAsync(HttpClient client, HttpResponseMessage response, CancellationToken cancellationToken)

Parameters

client HttpClient

The HTTP client.

response HttpResponseMessage

The response.

cancellationToken CancellationToken

The token to monitor for cancellation requests.

Returns

Task

A task that represents the asynchronous operation.