Compartilhar via


TypedResults Classe

Definição

Uma fábrica tipada para tipos de IResult no Microsoft.AspNetCore.Http.HttpResults.

public static class TypedResults
type TypedResults = class
Public Class TypedResults
Herança
TypedResults

Propriedades

Empty

Produz uma resposta de resultado vazia, que quando executada não fará nada.

Extensions

Fornece um contêiner para bibliotecas externas estenderem o padrão TypedResults definido com seus próprios exemplos.

Métodos

Accepted(String)

Produz uma resposta Status202Accepted.

Accepted(Uri)

Produz uma resposta Status202Accepted.

Accepted<TValue>(String, TValue)

Produz uma resposta Status202Accepted.

Accepted<TValue>(Uri, TValue)

Produz uma resposta Status202Accepted.

AcceptedAtRoute(String, Object)

Produz uma resposta Status202Accepted.

AcceptedAtRoute(String, RouteValueDictionary)

Produz uma resposta Status202Accepted.

AcceptedAtRoute<TValue>(TValue, String, Object)

Produz uma resposta Status202Accepted.

AcceptedAtRoute<TValue>(TValue, String, RouteValueDictionary)

Produz uma resposta Status202Accepted.

BadRequest()

Produz uma resposta Status400BadRequest.

BadRequest<TValue>(TValue)

Produz uma resposta Status400BadRequest.

Bytes(Byte[], String, String, Boolean, Nullable<DateTimeOffset>, EntityTagHeaderValue)

Grava o conteúdo da matriz de bytes na resposta.

Isso dá suporte a solicitações de intervalo (Status206PartialContent ou Status416RangeNotSatisfiable se o intervalo não for satisfiável).

Essa API é um alias para File(Byte[], String, String, Boolean, Nullable<DateTimeOffset>, EntityTagHeaderValue).

Bytes(ReadOnlyMemory<Byte>, String, String, Boolean, Nullable<DateTimeOffset>, EntityTagHeaderValue)

Grava o conteúdo da matriz de bytes na resposta.

Isso dá suporte a solicitações de intervalo (Status206PartialContent ou Status416RangeNotSatisfiable se o intervalo não for satisfiável).

Challenge(AuthenticationProperties, IList<String>)

Cria um ChallengeHttpResult que, na execução, invoca ChallengeAsync(HttpContext, String, AuthenticationProperties).

O comportamento desse método depende do IAuthenticationService em uso. Status401Unauthorized e Status403Forbidden estão entre os resultados de status prováveis.

Conflict()

Produz uma resposta Status409Conflict.

Conflict<TValue>(TValue)

Produz uma resposta Status409Conflict.

Content(String, MediaTypeHeaderValue)

Grava a cadeia de caracteres content na resposta HTTP.

Content(String, String, Encoding)

Grava a cadeia de caracteres content na resposta HTTP.

Isso é equivalente a Text(String, String, Encoding).

Content(String, String, Encoding, Nullable<Int32>)

Grava a cadeia de caracteres content na resposta HTTP.

Isso é equivalente a Text(String, String, Encoding, Nullable<Int32>).

Created()

Produz uma resposta Status201Created.

Created(String)

Produz uma resposta Status201Created.

Created(Uri)

Produz uma resposta Status201Created.

Created<TValue>(String, TValue)

Produz uma resposta Status201Created.

Created<TValue>(Uri, TValue)

Produz uma resposta Status201Created.

CreatedAtRoute(String, Object)

Produz uma resposta Status201Created.

CreatedAtRoute(String, RouteValueDictionary)

Produz uma resposta Status201Created.

CreatedAtRoute<TValue>(TValue, String, Object)

Produz uma resposta Status201Created.

CreatedAtRoute<TValue>(TValue, String, RouteValueDictionary)

Produz uma resposta Status201Created.

File(Byte[], String, String, Boolean, Nullable<DateTimeOffset>, EntityTagHeaderValue)

Grava o conteúdo da matriz de bytes na resposta.

Isso dá suporte a solicitações de intervalo (Status206PartialContent ou Status416RangeNotSatisfiable se o intervalo não for satisfiável).

Essa API é um alias para Bytes(Byte[], String, String, Boolean, Nullable<DateTimeOffset>, EntityTagHeaderValue).

File(Stream, String, String, Nullable<DateTimeOffset>, EntityTagHeaderValue, Boolean)

Grava o Stream especificado na resposta.

Isso dá suporte a solicitações de intervalo (Status206PartialContent ou Status416RangeNotSatisfiable se o intervalo não for satisfiável).

Essa API é um alias para Stream(Stream, String, String, Nullable<DateTimeOffset>, EntityTagHeaderValue, Boolean).

Forbid(AuthenticationProperties, IList<String>)

Cria um ForbidHttpResult que, na execução, invoca ForbidAsync(HttpContext, String, AuthenticationProperties).

Por padrão, a execução desse resultado retorna um Status403Forbidden. Alguns esquemas de autenticação, como cookies, converterão Status403Forbidden em um redirecionamento para mostrar uma página de logon.

InternalServerError()

Produz uma resposta Status500InternalServerError.

InternalServerError<TValue>(TValue)

Produz uma resposta Status500InternalServerError.

Json<TValue>(TValue, JsonSerializerContext, String, Nullable<Int32>)

Cria um JsonHttpResult<TValue> que serializa o objeto data especificado para JSON.

Json<TValue>(TValue, JsonSerializerOptions, String, Nullable<Int32>)

Cria um JsonHttpResult<TValue> que serializa o objeto data especificado para JSON.

Json<TValue>(TValue, JsonTypeInfo<TValue>, String, Nullable<Int32>)

Cria um JsonHttpResult<TValue> que serializa o objeto data especificado para JSON.

LocalRedirect(String, Boolean, Boolean)

Redireciona para o localUrlespecificado.

NoContent()

Produz uma resposta Status204NoContent.

NotFound()

Produz uma resposta Status404NotFound.

NotFound<TValue>(TValue)

Produz uma resposta Status404NotFound.

Ok()

Produz uma resposta Status200OK.

Ok<TValue>(TValue)

Produz uma resposta Status200OK.

PhysicalFile(String, String, String, Nullable<DateTimeOffset>, EntityTagHeaderValue, Boolean)

Grava o arquivo no path especificado na resposta.

Isso dá suporte a solicitações de intervalo (Status206PartialContent ou Status416RangeNotSatisfiable se o intervalo não for satisfiável).

Problem(ProblemDetails)

Produz uma resposta ProblemDetails.

Problem(String, String, Nullable<Int32>, String, String, IDictionary<String,Object>)

Produz uma resposta ProblemDetails.

Redirect(String, Boolean, Boolean)

Redireciona para o urlespecificado.

RedirectToRoute(String, Object, Boolean, Boolean, String)

Redireciona para a rota especificada.

RedirectToRoute(String, RouteValueDictionary, Boolean, Boolean, String)

Redireciona para a rota especificada.

SignIn(ClaimsPrincipal, AuthenticationProperties, String)

Cria um SignInHttpResult que, na execução, invoca SignInAsync(HttpContext, String, ClaimsPrincipal, AuthenticationProperties).

SignOut(AuthenticationProperties, IList<String>)

Cria um SignOutHttpResult que, na execução, invoca SignOutAsync(HttpContext, String, AuthenticationProperties).

StatusCode(Int32)

Cria um objeto StatusCodeHttpResult especificando um statusCode.

Stream(Func<Stream,Task>, String, String, Nullable<DateTimeOffset>, EntityTagHeaderValue)

Permite gravar diretamente no corpo da resposta.

Stream(PipeReader, String, String, Nullable<DateTimeOffset>, EntityTagHeaderValue, Boolean)

Grava o conteúdo do PipeReader especificado na resposta.

Isso dá suporte a solicitações de intervalo (Status206PartialContent ou Status416RangeNotSatisfiable se o intervalo não for satisfiável).

Stream(Stream, String, String, Nullable<DateTimeOffset>, EntityTagHeaderValue, Boolean)

Grava o Stream especificado na resposta.

Isso dá suporte a solicitações de intervalo (Status206PartialContent ou Status416RangeNotSatisfiable se o intervalo não for satisfiável).

Essa API é um alias para File(Stream, String, String, Nullable<DateTimeOffset>, EntityTagHeaderValue, Boolean).

Text(ReadOnlySpan<Byte>, String, Nullable<Int32>)

Grava o utf8Content conteúdo de texto UTF8 na resposta HTTP.

Text(String, String, Encoding)

Grava a cadeia de caracteres content na resposta HTTP.

Este é um alias para Content(String, String, Encoding).

Text(String, String, Encoding, Nullable<Int32>)

Grava a cadeia de caracteres content na resposta HTTP.

Este é um alias para Content(String, String, Encoding, Nullable<Int32>).

Unauthorized()

Produz uma resposta Status401Unauthorized.

UnprocessableEntity()

Produz uma resposta Status422UnprocessableEntity.

UnprocessableEntity<TValue>(TValue)

Produz uma resposta Status422UnprocessableEntity.

ValidationProblem(IDictionary<String,String[]>, String, String, String, String, IDictionary<String,Object>)

Produz uma resposta Status400BadRequest com um valor HttpValidationProblemDetails.

VirtualFile(String, String, String, Nullable<DateTimeOffset>, EntityTagHeaderValue, Boolean)

Grava o arquivo no path especificado na resposta.

Isso dá suporte a solicitações de intervalo (Status206PartialContent ou Status416RangeNotSatisfiable se o intervalo não for satisfiável).

Aplica-se a