TypedResults Třída

Definice

Typová továrna pro IResult typy v Microsoft.AspNetCore.Http.HttpResults.

public static class TypedResults
type TypedResults = class
Public Class TypedResults
Dědičnost
TypedResults

Vlastnosti

Name Description
Empty

Vygeneruje prázdnou odpověď výsledku, která při spuštění nic neudělá.

Extensions

Poskytuje kontejner pro externí knihovny pro rozšíření výchozí TypedResults sady vlastními ukázkami.

Metody

Name Description
Accepted(String)

Status202Accepted Vytvoří odpověď.

Accepted(Uri)

Status202Accepted Vytvoří odpověď.

Accepted<TValue>(String, TValue)

Status202Accepted Vytvoří odpověď.

Accepted<TValue>(Uri, TValue)

Status202Accepted Vytvoří odpověď.

AcceptedAtRoute(String, Object)

Status202Accepted Vytvoří odpověď.

AcceptedAtRoute(String, RouteValueDictionary)

Status202Accepted Vytvoří odpověď.

AcceptedAtRoute<TValue>(TValue, String, Object)

Status202Accepted Vytvoří odpověď.

AcceptedAtRoute<TValue>(TValue, String, RouteValueDictionary)

Status202Accepted Vytvoří odpověď.

BadRequest()

Status400BadRequest Vytvoří odpověď.

BadRequest<TValue>(TValue)

Status400BadRequest Vytvoří odpověď.

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

Zapíše obsah bajtového pole do odpovědi.

To podporuje žádosti o rozsah (Status206PartialContent nebo Status416RangeNotSatisfiable pokud rozsah není uspokojivý).

Toto rozhraní API je alias pro File(Byte[], String, String, Boolean, Nullable<DateTimeOffset>, EntityTagHeaderValue).

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

Zapíše obsah bajtového pole do odpovědi.

To podporuje žádosti o rozsah (Status206PartialContent nebo Status416RangeNotSatisfiable pokud rozsah není uspokojivý).

Challenge(AuthenticationProperties, IList<String>)

Vytvoří, ChallengeHttpResult že při spuštění vyvolá ChallengeAsync(HttpContext, String, AuthenticationProperties).

Chování této metody závisí na používané metodě IAuthenticationService . Status401Unauthorized a Status403Forbidden patří mezi pravděpodobné výsledky stavu.

Conflict()

Status409Conflict Vytvoří odpověď.

Conflict<TValue>(TValue)

Status409Conflict Vytvoří odpověď.

Content(String, MediaTypeHeaderValue)

Zapíše content řetězec do odpovědi HTTP.

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

Zapíše content řetězec do odpovědi HTTP.

To odpovídá Text(String, String, Encoding, Nullable<Int32>).

Content(String, String, Encoding)

Zapíše content řetězec do odpovědi HTTP.

To odpovídá Text(String, String, Encoding).

Created()

Status201Created Vytvoří odpověď.

Created(String)

Status201Created Vytvoří odpověď.

Created(Uri)

Status201Created Vytvoří odpověď.

Created<TValue>(String, TValue)

Status201Created Vytvoří odpověď.

Created<TValue>(Uri, TValue)

Status201Created Vytvoří odpověď.

CreatedAtRoute(String, Object)

Status201Created Vytvoří odpověď.

CreatedAtRoute(String, RouteValueDictionary)

Status201Created Vytvoří odpověď.

CreatedAtRoute<TValue>(TValue, String, Object)

Status201Created Vytvoří odpověď.

CreatedAtRoute<TValue>(TValue, String, RouteValueDictionary)

Status201Created Vytvoří odpověď.

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

Zapíše obsah bajtového pole do odpovědi.

To podporuje žádosti o rozsah (Status206PartialContent nebo Status416RangeNotSatisfiable pokud rozsah není uspokojivý).

Toto rozhraní API je alias pro Bytes(Byte[], String, String, Boolean, Nullable<DateTimeOffset>, EntityTagHeaderValue).

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

Zapíše zadanou Stream odpověď.

To podporuje žádosti o rozsah (Status206PartialContent nebo Status416RangeNotSatisfiable pokud rozsah není uspokojivý).

Toto rozhraní API je alias pro Stream(Stream, String, String, Nullable<DateTimeOffset>, EntityTagHeaderValue, Boolean).

Forbid(AuthenticationProperties, IList<String>)

Vytvoří, ForbidHttpResult že při spuštění vyvolá ForbidAsync(HttpContext, String, AuthenticationProperties).

Spuštění tohoto výsledku Status403Forbiddenve výchozím nastavení vrátí hodnotu . Některá schémata ověřování, například soubory cookie, se převedou Status403Forbidden na přesměrování, aby se zobrazila přihlašovací stránka.

InternalServerError()

Status500InternalServerError Vytvoří odpověď.

InternalServerError<TValue>(TValue)

Status500InternalServerError Vytvoří odpověď.

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

Vytvoří JsonHttpResult<TValue> serializaci zadaného data objektu do formátu JSON.

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

Vytvoří JsonHttpResult<TValue> serializaci zadaného data objektu do formátu JSON.

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

Vytvoří JsonHttpResult<TValue> serializaci zadaného data objektu do formátu JSON.

LocalRedirect(String, Boolean, Boolean)

Přesměruje na zadanou .localUrl

NoContent()

Status204NoContent Vytvoří odpověď.

NotFound()

Status404NotFound Vytvoří odpověď.

NotFound<TValue>(TValue)

Status404NotFound Vytvoří odpověď.

Ok()

Status200OK Vytvoří odpověď.

Ok<TValue>(TValue)

Status200OK Vytvoří odpověď.

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

Zapíše soubor do zadané path odpovědi.

To podporuje žádosti o rozsah (Status206PartialContent nebo Status416RangeNotSatisfiable pokud rozsah není uspokojivý).

Problem(ProblemDetails)

ProblemDetails Vytvoří odpověď.

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

ProblemDetails Vytvoří odpověď.

Problem(String, String, Nullable<Int32>, String, String, IEnumerable<KeyValuePair<String,Object>>)

ProblemDetails Vytvoří odpověď.

Redirect(String, Boolean, Boolean)

Přesměruje na zadanou .url

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

Přesměruje na zadanou trasu.

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

Přesměruje na zadanou trasu.

ServerSentEvents(IAsyncEnumerable<String>, String)

ServerSentEventsResult<T> Vytvoří odpověď.

ServerSentEvents<T>(IAsyncEnumerable<SseItem<T>>)

ServerSentEventsResult<T> Vytvoří odpověď.

ServerSentEvents<T>(IAsyncEnumerable<T>, String)

ServerSentEventsResult<T> Vytvoří odpověď.

SignIn(ClaimsPrincipal, AuthenticationProperties, String)

Vytvoří, SignInHttpResult že při spuštění vyvolá SignInAsync(HttpContext, String, ClaimsPrincipal, AuthenticationProperties).

SignOut(AuthenticationProperties, IList<String>)

Vytvoří, SignOutHttpResult že při spuštění vyvolá SignOutAsync(HttpContext, String, AuthenticationProperties).

StatusCode(Int32)

Vytvoří StatusCodeHttpResult objekt zadáním parametru statusCode.

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

Umožňuje zápis přímo do textu odpovědi.

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

Zapíše obsah zadané PipeReader odpovědi.

To podporuje žádosti o rozsah (Status206PartialContent nebo Status416RangeNotSatisfiable pokud rozsah není uspokojivý).

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

Zapíše zadanou Stream odpověď.

To podporuje žádosti o rozsah (Status206PartialContent nebo Status416RangeNotSatisfiable pokud rozsah není uspokojivý).

Toto rozhraní API je alias pro File(Stream, String, String, Nullable<DateTimeOffset>, EntityTagHeaderValue, Boolean).

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

utf8Content Zapíše textový obsah UTF8 do odpovědi HTTP.

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

Zapíše content řetězec do odpovědi HTTP.

Toto je alias pro Content(String, String, Encoding, Nullable<Int32>).

Text(String, String, Encoding)

Zapíše content řetězec do odpovědi HTTP.

Toto je alias pro Content(String, String, Encoding).

Unauthorized()

Status401Unauthorized Vytvoří odpověď.

UnprocessableEntity()

Status422UnprocessableEntity Vytvoří odpověď.

UnprocessableEntity<TValue>(TValue)

Status422UnprocessableEntity Vytvoří odpověď.

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

Status400BadRequest Vytvoří odpověď s HttpValidationProblemDetails hodnotou.

ValidationProblem(IEnumerable<KeyValuePair<String,String[]>>, String, String, String, String, IEnumerable<KeyValuePair<String,Object>>)

Status400BadRequest Vytvoří odpověď s HttpValidationProblemDetails hodnotou.

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

Zapíše soubor do zadané path odpovědi.

To podporuje žádosti o rozsah (Status206PartialContent nebo Status416RangeNotSatisfiable pokud rozsah není uspokojivý).

Platí pro