Class HttpResponseMessage<T>
Defines a HTTP response message that includes a deserializing option for the response data.
Inheritance
Namespace: MADE.Networking.Http.Responses
Assembly: MADE.Networking.dll
Syntax
public class HttpResponseMessage<T> : IDisposable
Type Parameters
Name | Description |
---|---|
T | The type of response expected. |
Constructors
| Improve this Doc View SourceHttpResponseMessage(HttpResponseMessage)
Initializes a new instance of the HttpResponseMessage<T> class with the original
Declaration
public HttpResponseMessage(HttpResponseMessage response)
Parameters
Type | Name | Description |
---|---|---|
MADE.Networking.Http.Responses.HttpResponseMessage | response | The original |
Properties
| Improve this Doc View SourceContent
Gets the content of the HTTP response message.
Declaration
public HttpContent Content { get; }
Property Value
Type | Description |
---|---|
HttpContent |
DeserializedContent
Gets the deserialized content of the original T
type.
Note, ensure that DeserializeAsync() has been called first, otherwise this value will be default.
Declaration
public T DeserializedContent { get; }
Property Value
Type | Description |
---|---|
T |
Headers
Gets the collection of HTTP response headers.
Declaration
public HttpResponseHeaders Headers { get; }
Property Value
Type | Description |
---|---|
HttpResponseHeaders |
IsSuccessStatusCode
Gets a value indicating whether the HTTP response was successful.
Declaration
public bool IsSuccessStatusCode { get; }
Property Value
Type | Description |
---|---|
System.Boolean |
ReasonPhrase
Gets the reason phrase that typically is sent by servers together with the status code.
Declaration
public string ReasonPhrase { get; }
Property Value
Type | Description |
---|---|
System.String |
RequestMessage
Gets the request message which led to this response message.
Declaration
public HttpRequestMessage RequestMessage { get; }
Property Value
Type | Description |
---|---|
HttpRequestMessage |
StatusCode
Gets the status code of the HTTP response.
Declaration
public HttpStatusCode StatusCode { get; }
Property Value
Type | Description |
---|---|
HttpStatusCode |
Version
Gets the HTTP message version.
Declaration
public Version Version { get; }
Property Value
Type | Description |
---|---|
Version |
Methods
| Improve this Doc View SourceDeserializeAsync()
Deserializes the content of the
Declaration
public async Task<T> DeserializeAsync()
Returns
Type | Description |
---|---|
Task<T> | A |
Dispose()
Releases the unmanaged resources and disposes of unmanaged resources used by the HttpResponseMessage<T>.
Declaration
public void Dispose()
Dispose(Boolean)
Releases the unmanaged resources used by the HttpResponseMessage<T> and optionally disposes of the managed resources.
Declaration
protected virtual void Dispose(bool disposing)
Parameters
Type | Name | Description |
---|---|---|
System.Boolean | disposing | A value indicating whether to release both managed and unmanaged resources. |
EnsureSuccessStatusCode()
Throws an exception if the IsSuccessStatusCode property for the HTTP response is false.
Declaration
public HttpResponseMessage<T> EnsureSuccessStatusCode()
Returns
Type | Description |
---|---|
HttpResponseMessage<T> | The HTTP response message if the call is successful. |
Operators
| Improve this Doc View SourceImplicit(HttpResponseMessage to HttpResponseMessage<T>)
Allows conversion of a
Declaration
public static implicit operator HttpResponseMessage<T>(HttpResponseMessage response)
Parameters
Type | Name | Description |
---|---|---|
MADE.Networking.Http.Responses.HttpResponseMessage | response | The |
Returns
Type | Description |
---|---|
HttpResponseMessage<T> |