Results Classe

Referência

Definição

Namespace:: Microsoft.AspNetCore.Http

Assembly:: Microsoft.AspNetCore.Http.Results.dll

Pacote:: Microsoft.AspNetCore.App.Ref v6.0.6

Pacote:: Microsoft.AspNetCore.App.Ref v7.0.5

Pacote:: Microsoft.AspNetCore.App.Ref v8.0.0

Pacote:: Microsoft.AspNetCore.App.Ref v9.0.0-preview.6.24328.4

Origem:: Results.cs

Importante

Algumas informações se referem a produtos de pré-lançamento que podem ser substancialmente modificados antes do lançamento. A Microsoft não oferece garantias, expressas ou implícitas, das informações aqui fornecidas.

Uma fábrica para IResult.

public static class Results

type Results = class

Public Class Results

Herança: Object
Results

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 `Results` definido com seus próprios exemplos.

Métodos

Accepted(String, Object)	Produz uma resposta Status202Accepted.
Accepted<TValue>(String, TValue)	Produz uma resposta Status202Accepted.
AcceptedAtRoute(String, Object, Object)	Produz uma resposta Status202Accepted.
AcceptedAtRoute(String, RouteValueDictionary, Object)	Produz uma resposta Status202Accepted.
AcceptedAtRoute<TValue>(String, Object, TValue)	Produz uma resposta Status202Accepted.
AcceptedAtRoute<TValue>(String, RouteValueDictionary, TValue)	Produz uma resposta Status202Accepted.
BadRequest(Object)	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 IResult 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(Object)	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, Object)	Produz uma resposta Status201Created.
Created(Uri, Object)	Produz uma resposta Status201Created.
Created<TValue>(String, TValue)	Produz uma resposta Status201Created.
Created<TValue>(Uri, TValue)	Produz uma resposta Status201Created.
CreatedAtRoute(String, Object, Object)	Produz uma resposta Status201Created.
CreatedAtRoute(String, RouteValueDictionary, Object)	Produz uma resposta Status201Created.
CreatedAtRoute<TValue>(String, Object, TValue)	Produz uma resposta Status201Created.
CreatedAtRoute<TValue>(String, RouteValueDictionary, TValue)	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).
File(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).
Forbid(AuthenticationProperties, IList<String>)	Cria um IResult 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(Object, JsonSerializerOptions, String, Nullable<Int32>)	Cria um IResult que serializa o objeto `data` especificado para JSON.
Json(Object, JsonTypeInfo, String, Nullable<Int32>)	Cria um IResult que serializa o objeto `data` especificado para JSON.
Json(Object, Type, JsonSerializerContext, String, Nullable<Int32>)	Cria um IResult que serializa o objeto `data` especificado para JSON.
Json<TValue>(TValue, JsonSerializerContext, String, Nullable<Int32>)	Cria um IResult que serializa o objeto `data` especificado para JSON.
Json<TValue>(TValue, JsonSerializerOptions, String, Nullable<Int32>)	Cria um IResult que serializa o objeto `data` especificado para JSON.
Json<TValue>(TValue, JsonTypeInfo<TValue>, String, Nullable<Int32>)	Cria um IResult que serializa o objeto `data` especificado para JSON.
LocalRedirect(String, Boolean, Boolean)	Redireciona para o `localUrl`especificado. Quando `permanent` e `preserveMethod` são definidos, define o código de status Status308PermanentRedirect. Quando `preserveMethod` é definido, define o código de status Status307TemporaryRedirect. Quando `permanent` é definido, define o código de status Status301MovedPermanently. Caso contrário, configura Status302Found.
NoContent()	Produz uma resposta Status204NoContent.
NotFound(Object)	Produz uma resposta Status404NotFound.
NotFound<TValue>(TValue)	Produz uma resposta Status404NotFound.
Ok(Object)	Produz uma resposta Status200OK.
Ok<TValue>(TValue)	Produz uma resposta Status200OK.
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 `url`especificado. Quando `permanent` e `preserveMethod` são definidos, define o código de status Status308PermanentRedirect. Quando `preserveMethod` é definido, define o código de status Status307TemporaryRedirect. Quando `permanent` é definido, define o código de status Status301MovedPermanently. Caso contrário, configura Status302Found.
RedirectToRoute(String, Object, Boolean, Boolean, String)	Redireciona para a rota especificada. Quando `permanent` e `preserveMethod` são definidos, define o código de status Status308PermanentRedirect. Quando `preserveMethod` é definido, define o código de status Status307TemporaryRedirect. Quando `permanent` é definido, define o código de status Status301MovedPermanently. Caso contrário, configura Status302Found.
RedirectToRoute(String, RouteValueDictionary, Boolean, Boolean, String)	Redireciona para a rota especificada. Quando `permanent` e `preserveMethod` são definidos, define o código de status Status308PermanentRedirect. Quando `preserveMethod` é definido, define o código de status Status307TemporaryRedirect. Quando `permanent` é definido, define o código de status Status301MovedPermanently. Caso contrário, configura Status302Found.
SignIn(ClaimsPrincipal, AuthenticationProperties, String)	Cria um IResult que, na execução, invoca SignInAsync(HttpContext, String, ClaimsPrincipal, AuthenticationProperties).
SignOut(AuthenticationProperties, IList<String>)	Cria um IResult que, na execução, invoca SignOutAsync(HttpContext, String, AuthenticationProperties).
StatusCode(Int32)	Cria um objeto IResult 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` texto codificado em UTF-8 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(Object)	Produz uma resposta Status422UnprocessableEntity.
UnprocessableEntity<TValue>(TValue)	Produz uma resposta Status422UnprocessableEntity.
ValidationProblem(IDictionary<String,String[]>, String, String, Nullable<Int32>, String, String, IDictionary<String,Object>)	Produz uma resposta Status400BadRequest com um valor HttpValidationProblemDetails.

Aplica-se a

Partilhar via

Results Classe

Definição

Propriedades

Métodos

Aplica-se a

Comentários

Recursos adicionais