Results Klasse

  • Referenz

Definition

Namespace:
Microsoft.AspNetCore.Http
Assembly:
Microsoft.AspNetCore.Http.Results.dll
Paket:
Microsoft.AspNetCore.App.Ref v6.0.6
Paket:
Microsoft.AspNetCore.App.Ref v7.0.5
Paket:
Microsoft.AspNetCore.App.Ref v8.0.0
Paket:
Microsoft.AspNetCore.App.Ref v9.0.0-preview.6.24328.4
Quelle:
Results.cs

Eine Fabrik für IResult.

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

Eigenschaften

Empty

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

Stellt einen Container für externe Bibliotheken bereit, um die Standard-Results mit ihren eigenen Beispielen zu erweitern.

Methoden

Accepted(String, Object)

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

Erzeugt eine Status202Accepted Antwort.
AcceptedAtRoute(String, Object, Object)

Erzeugt eine Status202Accepted Antwort.
AcceptedAtRoute(String, RouteValueDictionary, Object)

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

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

Erzeugt eine Status202Accepted Antwort.
BadRequest(Object)

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 eine IResult, die bei der Ausführung ChallengeAsync(HttpContext, String, AuthenticationProperties)aufruft.

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

Conflict(Object)

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)

Schreibt die content Zeichenfolge in die HTTP-Antwort.

Dies entspricht Text(String, String, Encoding).

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

Schreibt die content Zeichenfolge in die HTTP-Antwort.

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

Created()

Erzeugt eine Status201Created Antwort.
Created(String, Object)

Erzeugt eine Status201Created Antwort.
Created(Uri, Object)

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

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

Erzeugt eine Status201Created Antwort.
CreatedAtRoute(String, Object, Object)

Erzeugt eine Status201Created Antwort.
CreatedAtRoute(String, RouteValueDictionary, Object)

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

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

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 in die 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).

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

Schreibt die Datei an der angegebenen path in die Antwort.

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

Forbid(AuthenticationProperties, IList<String>)

Erstellt eine IResult, die bei der Ausführung ForbidAsync(HttpContext, String, AuthenticationProperties)aufruft.

Standardmäßig gibt das Ausführen dieses Ergebnisses eine Status403Forbiddenzurück. Einige Authentifizierungsschemas, z. B. Cookies, konvertieren Status403Forbidden in eine Umleitung, um eine Anmeldeseite anzuzeigen.

InternalServerError()

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

Erzeugt eine Status500InternalServerError Antwort.
Json(Object, JsonSerializerOptions, String, Nullable<Int32>)

Erstellt eine IResult, die das angegebene data -Objekt in JSON serialisiert.
Json(Object, JsonTypeInfo, String, Nullable<Int32>)

Erstellt eine IResult, die das angegebene data -Objekt in JSON serialisiert.
Json(Object, Type, JsonSerializerContext, String, Nullable<Int32>)

Erstellt eine IResult, die das angegebene data -Objekt in JSON serialisiert.
Json<TValue>(TValue, JsonSerializerContext, String, Nullable<Int32>)

Erstellt eine IResult, die das angegebene data -Objekt in JSON serialisiert.
Json<TValue>(TValue, JsonSerializerOptions, String, Nullable<Int32>)

Erstellt eine IResult, die das angegebene data -Objekt in JSON serialisiert.
Json<TValue>(TValue, JsonTypeInfo<TValue>, String, Nullable<Int32>)

Erstellt eine IResult, die das angegebene data -Objekt in JSON serialisiert.
LocalRedirect(String, Boolean, Boolean)

Leitet an die angegebene localUrlum.
NoContent()

Erzeugt eine Status204NoContent Antwort.
NotFound(Object)

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

Erzeugt eine Status404NotFound Antwort.
Ok(Object)

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

Erzeugt eine Status200OK Antwort.
Problem(ProblemDetails)

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

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

Leitet an die angegebene urlum.
RedirectToRoute(String, Object, Boolean, Boolean, String)

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

Leitet an die angegebene Route um.
SignIn(ClaimsPrincipal, AuthenticationProperties, String)

Erstellt eine IResult, die bei der Ausführung SignInAsync(HttpContext, String, ClaimsPrincipal, AuthenticationProperties)aufruft.
SignOut(AuthenticationProperties, IList<String>)

Erstellt eine IResult, die bei der Ausführung SignOutAsync(HttpContext, String, AuthenticationProperties)aufruft.
StatusCode(Int32)

Erstellt ein IResult -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 in die 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 in die 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 UTF-8-codierten Text in die HTTP-Antwort.
Text(String, String, Encoding)

Schreibt die content Zeichenfolge in die HTTP-Antwort.

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

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>).

Unauthorized()

Erzeugt eine Status401Unauthorized Antwort.
UnprocessableEntity(Object)

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

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

Erzeugt eine Status400BadRequest Antwort mit einem HttpValidationProblemDetails Wert.

Gilt für: