TypedResults Classe

Définition

Espace de noms:: Microsoft.AspNetCore.Http

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

Paquet:: Microsoft.AspNetCore.App.Ref v10.0.0

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

Paquet:: Microsoft.AspNetCore.App.Ref v8.0.19

Paquet:: Microsoft.AspNetCore.App.Ref v9.0.8

Source:: TypedResults.cs

Important

Certaines informations portent sur la préversion du produit qui est susceptible d’être en grande partie modifiée avant sa publication. Microsoft exclut toute garantie, expresse ou implicite, concernant les informations fournies ici.

Fabrique typée pour IResult les types dans Microsoft.AspNetCore.Http.HttpResults.

public static class TypedResults

type TypedResults = class

Public Class TypedResults

Héritage: Object
TypedResults

Propriétés

Nom	Description
Empty	Produit une réponse de résultat vide, qui, lorsqu’elle est exécutée, ne fera rien.
Extensions	Fournit un conteneur pour les bibliothèques externes afin d’étendre l’ensemble par défaut `TypedResults` avec leurs propres exemples.

Méthodes

Nom	Description
Accepted(String)	Génère une Status202Accepted réponse.
Accepted(Uri)	Génère une Status202Accepted réponse.
Accepted<TValue>(String, TValue)	Génère une Status202Accepted réponse.
Accepted<TValue>(Uri, TValue)	Génère une Status202Accepted réponse.
AcceptedAtRoute(String, Object)	Génère une Status202Accepted réponse.
AcceptedAtRoute(String, RouteValueDictionary)	Génère une Status202Accepted réponse.
AcceptedAtRoute<TValue>(TValue, String, Object)	Génère une Status202Accepted réponse.
AcceptedAtRoute<TValue>(TValue, String, RouteValueDictionary)	Génère une Status202Accepted réponse.
BadRequest()	Génère une Status400BadRequest réponse.
BadRequest<TValue>(TValue)	Génère une Status400BadRequest réponse.
Bytes(Byte[], String, String, Boolean, Nullable<DateTimeOffset>, EntityTagHeaderValue)	Écrit le contenu de tableau d’octets dans la réponse. Cela prend en charge les requêtes de plage (Status206PartialContent ou Status416RangeNotSatisfiable si la plage n’est pas satisfaisante). Cette API est un alias pour File(Byte[], String, String, Boolean, Nullable<DateTimeOffset>, EntityTagHeaderValue).
Bytes(ReadOnlyMemory<Byte>, String, String, Boolean, Nullable<DateTimeOffset>, EntityTagHeaderValue)	Écrit le contenu de tableau d’octets dans la réponse. Cela prend en charge les requêtes de plage (Status206PartialContent ou Status416RangeNotSatisfiable si la plage n’est pas satisfaisante).
Challenge(AuthenticationProperties, IList<String>)	Crée un ChallengeHttpResult élément qui, lors de l’exécution, appelle ChallengeAsync(HttpContext, String, AuthenticationProperties). Le comportement de cette méthode dépend de l’utilisation IAuthenticationService . Status401Unauthorized et Status403Forbidden sont parmi les résultats d’état probables.
Conflict()	Génère une Status409Conflict réponse.
Conflict<TValue>(TValue)	Génère une Status409Conflict réponse.
Content(String, MediaTypeHeaderValue)	Écrit la `content` chaîne dans la réponse HTTP.
Content(String, String, Encoding, Nullable<Int32>)	Écrit la `content` chaîne dans la réponse HTTP. Ceci équivaut à Text(String, String, Encoding, Nullable<Int32>).
Content(String, String, Encoding)	Écrit la `content` chaîne dans la réponse HTTP. Ceci équivaut à Text(String, String, Encoding).
Created()	Génère une Status201Created réponse.
Created(String)	Génère une Status201Created réponse.
Created(Uri)	Génère une Status201Created réponse.
Created<TValue>(String, TValue)	Génère une Status201Created réponse.
Created<TValue>(Uri, TValue)	Génère une Status201Created réponse.
CreatedAtRoute(String, Object)	Génère une Status201Created réponse.
CreatedAtRoute(String, RouteValueDictionary)	Génère une Status201Created réponse.
CreatedAtRoute<TValue>(TValue, String, Object)	Génère une Status201Created réponse.
CreatedAtRoute<TValue>(TValue, String, RouteValueDictionary)	Génère une Status201Created réponse.
File(Byte[], String, String, Boolean, Nullable<DateTimeOffset>, EntityTagHeaderValue)	Écrit le contenu de tableau d’octets dans la réponse. Cela prend en charge les requêtes de plage (Status206PartialContent ou Status416RangeNotSatisfiable si la plage n’est pas satisfaisante). Cette API est un alias pour Bytes(Byte[], String, String, Boolean, Nullable<DateTimeOffset>, EntityTagHeaderValue).
File(Stream, String, String, Nullable<DateTimeOffset>, EntityTagHeaderValue, Boolean)	Écrit le spécifié Stream dans la réponse. Cela prend en charge les requêtes de plage (Status206PartialContent ou Status416RangeNotSatisfiable si la plage n’est pas satisfaisante). Cette API est un alias pour Stream(Stream, String, String, Nullable<DateTimeOffset>, EntityTagHeaderValue, Boolean).
Forbid(AuthenticationProperties, IList<String>)	Crée un ForbidHttpResult élément qui, lors de l’exécution, appelle ForbidAsync(HttpContext, String, AuthenticationProperties). Par défaut, l’exécution de ce résultat retourne un Status403Forbidden. Certains schémas d’authentification, tels que les cookies, sont convertis Status403Forbidden en redirection pour afficher une page de connexion.
InternalServerError()	Génère une Status500InternalServerError réponse.
InternalServerError<TValue>(TValue)	Génère une Status500InternalServerError réponse.
Json<TValue>(TValue, JsonSerializerContext, String, Nullable<Int32>)	Crée un JsonHttpResult<TValue> qui sérialise l’objet spécifié `data` en JSON.
Json<TValue>(TValue, JsonSerializerOptions, String, Nullable<Int32>)	Crée un JsonHttpResult<TValue> qui sérialise l’objet spécifié `data` en JSON.
Json<TValue>(TValue, JsonTypeInfo<TValue>, String, Nullable<Int32>)	Crée un JsonHttpResult<TValue> qui sérialise l’objet spécifié `data` en JSON.
LocalRedirect(String, Boolean, Boolean)	Redirige vers le fichier spécifié `localUrl`. Quand `permanent` et `preserveMethod` sont définis, définit le code d’état Status308PermanentRedirect . Quand `preserveMethod` elle est définie, définit le code d’état Status307TemporaryRedirect . Quand `permanent` elle est définie, définit le code d’état Status301MovedPermanently . Sinon, configure Status302Found.
NoContent()	Génère une Status204NoContent réponse.
NotFound()	Génère une Status404NotFound réponse.
NotFound<TValue>(TValue)	Génère une Status404NotFound réponse.
Ok()	Génère une Status200OK réponse.
Ok<TValue>(TValue)	Génère une Status200OK réponse.
PhysicalFile(String, String, String, Nullable<DateTimeOffset>, EntityTagHeaderValue, Boolean)	Écrit le fichier à l’emplacement spécifié `path` dans la réponse. Cela prend en charge les requêtes de plage (Status206PartialContent ou Status416RangeNotSatisfiable si la plage n’est pas satisfaisante).
Problem(ProblemDetails)	Génère une ProblemDetails réponse.
Problem(String, String, Nullable<Int32>, String, String, IDictionary<String,Object>)	Génère une ProblemDetails réponse.
Problem(String, String, Nullable<Int32>, String, String, IEnumerable<KeyValuePair<String,Object>>)	Génère une ProblemDetails réponse.
Redirect(String, Boolean, Boolean)	Redirige vers le fichier spécifié `url`. Quand `permanent` et `preserveMethod` sont définis, définit le code d’état Status308PermanentRedirect . Quand `preserveMethod` elle est définie, définit le code d’état Status307TemporaryRedirect . Quand `permanent` elle est définie, définit le code d’état Status301MovedPermanently . Sinon, configure Status302Found.
RedirectToRoute(String, Object, Boolean, Boolean, String)	Redirige vers l’itinéraire spécifié. Quand `permanent` et `preserveMethod` sont définis, définit le code d’état Status308PermanentRedirect . Quand `preserveMethod` elle est définie, définit le code d’état Status307TemporaryRedirect . Quand `permanent` elle est définie, définit le code d’état Status301MovedPermanently . Sinon, configure Status302Found.
RedirectToRoute(String, RouteValueDictionary, Boolean, Boolean, String)	Redirige vers l’itinéraire spécifié. Quand `permanent` et `preserveMethod` sont définis, définit le code d’état Status308PermanentRedirect . Quand `preserveMethod` elle est définie, définit le code d’état Status307TemporaryRedirect . Quand `permanent` elle est définie, définit le code d’état Status301MovedPermanently . Sinon, configure Status302Found.
ServerSentEvents(IAsyncEnumerable<String>, String)	Génère une ServerSentEventsResult<T> réponse.
ServerSentEvents<T>(IAsyncEnumerable<SseItem<T>>)	Génère une ServerSentEventsResult<T> réponse.
ServerSentEvents<T>(IAsyncEnumerable<T>, String)	Génère une ServerSentEventsResult<T> réponse.
SignIn(ClaimsPrincipal, AuthenticationProperties, String)	Crée un SignInHttpResult élément qui, lors de l’exécution, appelle SignInAsync(HttpContext, String, ClaimsPrincipal, AuthenticationProperties).
SignOut(AuthenticationProperties, IList<String>)	Crée un SignOutHttpResult élément qui, lors de l’exécution, appelle SignOutAsync(HttpContext, String, AuthenticationProperties).
StatusCode(Int32)	Crée un StatusCodeHttpResult objet en spécifiant un `statusCode`.
Stream(Func<Stream,Task>, String, String, Nullable<DateTimeOffset>, EntityTagHeaderValue)	Permet d’écrire directement dans le corps de la réponse.
Stream(PipeReader, String, String, Nullable<DateTimeOffset>, EntityTagHeaderValue, Boolean)	Écrit le contenu du contenu spécifié PipeReader dans la réponse. Cela prend en charge les requêtes de plage (Status206PartialContent ou Status416RangeNotSatisfiable si la plage n’est pas satisfaisante).
Stream(Stream, String, String, Nullable<DateTimeOffset>, EntityTagHeaderValue, Boolean)	Écrit le spécifié Stream dans la réponse. Cela prend en charge les requêtes de plage (Status206PartialContent ou Status416RangeNotSatisfiable si la plage n’est pas satisfaisante). Cette API est un alias pour File(Stream, String, String, Nullable<DateTimeOffset>, EntityTagHeaderValue, Boolean).
Text(ReadOnlySpan<Byte>, String, Nullable<Int32>)	Écrit le `utf8Content` contenu texte UTF8 dans la réponse HTTP.
Text(String, String, Encoding, Nullable<Int32>)	Écrit la `content` chaîne dans la réponse HTTP. Il s’agit d’un alias pour Content(String, String, Encoding, Nullable<Int32>).
Text(String, String, Encoding)	Écrit la `content` chaîne dans la réponse HTTP. Il s’agit d’un alias pour Content(String, String, Encoding).
Unauthorized()	Génère une Status401Unauthorized réponse.
UnprocessableEntity()	Génère une Status422UnprocessableEntity réponse.
UnprocessableEntity<TValue>(TValue)	Génère une Status422UnprocessableEntity réponse.
ValidationProblem(IDictionary<String,String[]>, String, String, String, String, IDictionary<String,Object>)	Produit une Status400BadRequest réponse avec une HttpValidationProblemDetails valeur.
ValidationProblem(IEnumerable<KeyValuePair<String,String[]>>, String, String, String, String, IEnumerable<KeyValuePair<String,Object>>)	Produit une Status400BadRequest réponse avec une HttpValidationProblemDetails valeur.
VirtualFile(String, String, String, Nullable<DateTimeOffset>, EntityTagHeaderValue, Boolean)	Écrit le fichier à l’emplacement spécifié `path` dans la réponse. Cela prend en charge les requêtes de plage (Status206PartialContent ou Status416RangeNotSatisfiable si la plage n’est pas satisfaisante).

S’applique à

Commentaires

Cette page a-t-elle été utile ?