Class NegotiatedContentResult<T>

Namespace

System.Web.Http.Results

Assembly

System.Web.Http.dll

Represents an action result that performs content negotiation.

public class NegotiatedContentResult<T> : IHttpActionResult

Type Parameters

T

The type of content in the entity body.

Inheritance

object

NegotiatedContentResult<T>

Implements

IHttpActionResult

Inherited Members

object.GetType()

object.MemberwiseClone()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Constructors

NegotiatedContentResult(HttpStatusCode, T, IContentNegotiator, HttpRequestMessage, IEnumerable<MediaTypeFormatter>)

Initializes a new instance of the NegotiatedContentResult<T> class with the values provided.

public NegotiatedContentResult(HttpStatusCode statusCode, T content, IContentNegotiator contentNegotiator, HttpRequestMessage request, IEnumerable<MediaTypeFormatter> formatters)

Parameters

statusCode HttpStatusCode

The HTTP status code for the response message.

content T

The content value to negotiate and format in the entity body.

contentNegotiator IContentNegotiator

The content negotiator to handle content negotiation.

request HttpRequestMessage

The request message which led to this result.

formatters IEnumerable<MediaTypeFormatter>

The formatters to use to negotiate and format the content.

NegotiatedContentResult(HttpStatusCode, T, ApiController)

Initializes a new instance of the NegotiatedContentResult<T> class with the values provided.

public NegotiatedContentResult(HttpStatusCode statusCode, T content, ApiController controller)

Parameters

statusCode HttpStatusCode

The HTTP status code for the response message.

content T

The content value to negotiate and format in the entity body.

controller ApiController

The controller from which to obtain the dependencies needed for execution.

Properties

Content

Gets the content value to negotiate and format in the entity body.

public T Content { get; }

Property Value

T

The content value to negotiate and format in the entity body.

ContentNegotiator

Gets the content negotiator to handle content negotiation.

public IContentNegotiator ContentNegotiator { get; }

Property Value

IContentNegotiator

The content negotiator to handle content negotiation.

Formatters

Gets the formatters to use to negotiate and format the content.

public IEnumerable<MediaTypeFormatter> Formatters { get; }

Property Value

IEnumerable<MediaTypeFormatter>

The formatters to use to negotiate and format the content.

Request

Gets the request message which led to this result.

public HttpRequestMessage Request { get; }

Property Value

HttpRequestMessage

The HTTP request message which led to this result.

StatusCode

Gets the HTTP status code for the response message.

public HttpStatusCode StatusCode { get; }

Property Value

HttpStatusCode

The HTTP status code for the response message.

Methods

ExecuteAsync(CancellationToken)

Executes asynchronously an HTTP negotiated content results.

public virtual Task<HttpResponseMessage> ExecuteAsync(CancellationToken cancellationToken)

Parameters

cancellationToken CancellationToken

The cancellation token.

Returns

Task<HttpResponseMessage>

Asynchronously executes an HTTP negotiated content results.