Freigeben über

TypedResults Klasse

Definition

Namespace:
Microsoft.AspNetCore.Http
Assembly:
Microsoft.AspNetCore.Http.Results.dll
Paket:
Microsoft.AspNetCore.App.Ref v10.0.0
Paket:
Microsoft.AspNetCore.App.Ref v7.0.5
Paket:
Microsoft.AspNetCore.App.Ref v8.0.19
Paket:
Microsoft.AspNetCore.App.Ref v9.0.8
Quelle:
TypedResults.cs

Eine typierte Fabrik für IResult Typen in Microsoft.AspNetCore.Http.HttpResults.

public static class TypedResults
type TypedResults = class
Public Class TypedResults
Vererbung
Object
TypedResults

Eigenschaften

Name Beschreibung
Empty

Erzeugt eine leere Ergebnisantwort, die bei ausführung keine Aktion ausführt.
Extensions

Stellt einen Container für externe Bibliotheken bereit, um den Standardsatz TypedResults mit eigenen Beispielen zu erweitern.

Methoden

Name Beschreibung
Accepted(String)

Erzeugt eine Status202Accepted Antwort.
Accepted(Uri)

Erzeugt eine Status202Accepted Antwort.
Accepted<TValue>(String, TValue)

Erzeugt eine Status202Accepted Antwort.
Accepted<TValue>(Uri, TValue)

Erzeugt eine Status202Accepted Antwort.
AcceptedAtRoute(String, Object)

Erzeugt eine Status202Accepted Antwort.
AcceptedAtRoute(String, RouteValueDictionary)

Erzeugt eine Status202Accepted Antwort.
AcceptedAtRoute<TValue>(TValue, String, Object)

Erzeugt eine Status202Accepted Antwort.
AcceptedAtRoute<TValue>(TValue, String, RouteValueDictionary)

Erzeugt eine Status202Accepted Antwort.
BadRequest()

Erzeugt eine Status400BadRequest Antwort.
BadRequest<TValue>(TValue)

Erzeugt eine Status400BadRequest Antwort.
Bytes(Byte[], String, String, Boolean, Nullable<DateTimeOffset>, EntityTagHeaderValue)

Schreibt den Bytearrayinhalt in die Antwort.

Dies unterstützt Bereichsanforderungen (Status206PartialContent oder Status416RangeNotSatisfiable wenn der Bereich nicht zufriedenstellend ist).

Diese API ist ein Alias für File(Byte[], String, String, Boolean, Nullable<DateTimeOffset>, EntityTagHeaderValue).
Bytes(ReadOnlyMemory<Byte>, String, String, Boolean, Nullable<DateTimeOffset>, EntityTagHeaderValue)

Schreibt den Bytearrayinhalt in die Antwort.

Dies unterstützt Bereichsanforderungen (Status206PartialContent oder Status416RangeNotSatisfiable wenn der Bereich nicht zufriedenstellend ist).

Challenge(AuthenticationProperties, IList<String>)

Erstellt ein ChallengeHttpResult , das bei der Ausführung aufgerufen wird ChallengeAsync(HttpContext, String, AuthenticationProperties).

Das Verhalten dieser Methode hängt von der IAuthenticationService Verwendung ab. Status401Unauthorized und Status403Forbidden gehören zu den wahrscheinlichen Statusergebnissen.

Conflict()

Erzeugt eine Status409Conflict Antwort.
Conflict<TValue>(TValue)

Erzeugt eine Status409Conflict Antwort.
Content(String, MediaTypeHeaderValue)

Schreibt die content Zeichenfolge in die HTTP-Antwort.
Content(String, String, Encoding, Nullable<Int32>)

Schreibt die content Zeichenfolge in die HTTP-Antwort.

Dieser entspricht Text(String, String, Encoding, Nullable<Int32>).

Content(String, String, Encoding)

Schreibt die content Zeichenfolge in die HTTP-Antwort.

Dieser entspricht Text(String, String, Encoding).

Created()

Erzeugt eine Status201Created Antwort.
Created(String)

Erzeugt eine Status201Created Antwort.
Created(Uri)

Erzeugt eine Status201Created Antwort.
Created<TValue>(String, TValue)

Erzeugt eine Status201Created Antwort.
Created<TValue>(Uri, TValue)

Erzeugt eine Status201Created Antwort.
CreatedAtRoute(String, Object)

Erzeugt eine Status201Created Antwort.
CreatedAtRoute(String, RouteValueDictionary)

Erzeugt eine Status201Created Antwort.
CreatedAtRoute<TValue>(TValue, String, Object)

Erzeugt eine Status201Created Antwort.
CreatedAtRoute<TValue>(TValue, String, RouteValueDictionary)

Erzeugt eine Status201Created Antwort.
File(Byte[], String, String, Boolean, Nullable<DateTimeOffset>, EntityTagHeaderValue)

Schreibt den Bytearrayinhalt in die Antwort.

Dies unterstützt Bereichsanforderungen (Status206PartialContent oder Status416RangeNotSatisfiable wenn der Bereich nicht zufriedenstellend ist).

Diese API ist ein Alias für Bytes(Byte[], String, String, Boolean, Nullable<DateTimeOffset>, EntityTagHeaderValue).
File(Stream, String, String, Nullable<DateTimeOffset>, EntityTagHeaderValue, Boolean)

Schreibt die angegebene Stream Antwort.

Dies unterstützt Bereichsanforderungen (Status206PartialContent oder Status416RangeNotSatisfiable wenn der Bereich nicht zufriedenstellend ist).

Diese API ist ein Alias für Stream(Stream, String, String, Nullable<DateTimeOffset>, EntityTagHeaderValue, Boolean).

Forbid(AuthenticationProperties, IList<String>)

Erstellt ein ForbidHttpResult , das bei der Ausführung aufgerufen wird ForbidAsync(HttpContext, String, AuthenticationProperties).

Standardmäßig gibt die Ausführung dieses Ergebnisses ein Status403Forbidden. Einige Authentifizierungsschemas, z. B. Cookies, werden in eine Umleitung konvertiert Status403Forbidden , um eine Anmeldeseite anzuzeigen.

InternalServerError()

Erzeugt eine Status500InternalServerError Antwort.
InternalServerError<TValue>(TValue)

Erzeugt eine Status500InternalServerError Antwort.
Json<TValue>(TValue, JsonSerializerContext, String, Nullable<Int32>)

Erstellt ein JsonHttpResult<TValue> Objekt, das das angegebene data Objekt in JSON serialisiert.
Json<TValue>(TValue, JsonSerializerOptions, String, Nullable<Int32>)

Erstellt ein JsonHttpResult<TValue> Objekt, das das angegebene data Objekt in JSON serialisiert.
Json<TValue>(TValue, JsonTypeInfo<TValue>, String, Nullable<Int32>)

Erstellt ein JsonHttpResult<TValue> Objekt, das das angegebene data Objekt in JSON serialisiert.
LocalRedirect(String, Boolean, Boolean)

Leitet an den angegebenen localUrlUmleitungs-Wert um.
NoContent()

Erzeugt eine Status204NoContent Antwort.
NotFound()

Erzeugt eine Status404NotFound Antwort.
NotFound<TValue>(TValue)

Erzeugt eine Status404NotFound Antwort.
Ok()

Erzeugt eine Status200OK Antwort.
Ok<TValue>(TValue)

Erzeugt eine Status200OK Antwort.
PhysicalFile(String, String, String, Nullable<DateTimeOffset>, EntityTagHeaderValue, Boolean)

Schreibt die Datei an der angegebenen path Antwort.

Dies unterstützt Bereichsanforderungen (Status206PartialContent oder Status416RangeNotSatisfiable wenn der Bereich nicht zufriedenstellend ist).

Problem(ProblemDetails)

Erzeugt eine ProblemDetails Antwort.
Problem(String, String, Nullable<Int32>, String, String, IDictionary<String,Object>)

Erzeugt eine ProblemDetails Antwort.
Problem(String, String, Nullable<Int32>, String, String, IEnumerable<KeyValuePair<String,Object>>)

Erzeugt eine ProblemDetails Antwort.
Redirect(String, Boolean, Boolean)

Leitet an den angegebenen urlUmleitungs-Wert um.
RedirectToRoute(String, Object, Boolean, Boolean, String)

Leitet an die angegebene Route um.
RedirectToRoute(String, RouteValueDictionary, Boolean, Boolean, String)

Leitet an die angegebene Route um.
ServerSentEvents(IAsyncEnumerable<String>, String)

Erzeugt eine ServerSentEventsResult<T> Antwort.
ServerSentEvents<T>(IAsyncEnumerable<SseItem<T>>)

Erzeugt eine ServerSentEventsResult<T> Antwort.
ServerSentEvents<T>(IAsyncEnumerable<T>, String)

Erzeugt eine ServerSentEventsResult<T> Antwort.
SignIn(ClaimsPrincipal, AuthenticationProperties, String)

Erstellt ein SignInHttpResult , das bei der Ausführung aufgerufen wird SignInAsync(HttpContext, String, ClaimsPrincipal, AuthenticationProperties).
SignOut(AuthenticationProperties, IList<String>)

Erstellt ein SignOutHttpResult , das bei der Ausführung aufgerufen wird SignOutAsync(HttpContext, String, AuthenticationProperties).
StatusCode(Int32)

Erstellt ein StatusCodeHttpResult Objekt durch Angeben eines statusCode.
Stream(Func<Stream,Task>, String, String, Nullable<DateTimeOffset>, EntityTagHeaderValue)

Ermöglicht das direkte Schreiben in den Antworttext.
Stream(PipeReader, String, String, Nullable<DateTimeOffset>, EntityTagHeaderValue, Boolean)

Schreibt den Inhalt der angegebenen PipeReader Antwort.

Dies unterstützt Bereichsanforderungen (Status206PartialContent oder Status416RangeNotSatisfiable wenn der Bereich nicht zufriedenstellend ist).

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

Schreibt die angegebene Stream Antwort.

Dies unterstützt Bereichsanforderungen (Status206PartialContent oder Status416RangeNotSatisfiable wenn der Bereich nicht zufriedenstellend ist).

Diese API ist ein Alias für File(Stream, String, String, Nullable<DateTimeOffset>, EntityTagHeaderValue, Boolean).

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

Schreibt den utf8Content UTF8-Textinhalt in die HTTP-Antwort.
Text(String, String, Encoding, Nullable<Int32>)

Schreibt die content Zeichenfolge in die HTTP-Antwort.

Dies ist ein Alias für Content(String, String, Encoding, Nullable<Int32>).

Text(String, String, Encoding)

Schreibt die content Zeichenfolge in die HTTP-Antwort.

Dies ist ein Alias für Content(String, String, Encoding).

Unauthorized()

Erzeugt eine Status401Unauthorized Antwort.
UnprocessableEntity()

Erzeugt eine Status422UnprocessableEntity Antwort.
UnprocessableEntity<TValue>(TValue)

Erzeugt eine Status422UnprocessableEntity Antwort.
ValidationProblem(IDictionary<String,String[]>, String, String, String, String, IDictionary<String,Object>)

Erzeugt eine Status400BadRequest Antwort mit einem HttpValidationProblemDetails Wert.
ValidationProblem(IEnumerable<KeyValuePair<String,String[]>>, String, String, String, String, IEnumerable<KeyValuePair<String,Object>>)

Erzeugt eine Status400BadRequest Antwort mit einem HttpValidationProblemDetails Wert.
VirtualFile(String, String, String, Nullable<DateTimeOffset>, EntityTagHeaderValue, Boolean)

Schreibt die Datei an der angegebenen path Antwort.

Dies unterstützt Bereichsanforderungen (Status206PartialContent oder Status416RangeNotSatisfiable wenn der Bereich nicht zufriedenstellend ist).

Gilt für: