Поделиться через


TypedResults Класс

Определение

Типизированный завод для IResult типов в Microsoft.AspNetCore.Http.HttpResults.

public static class TypedResults
type TypedResults = class
Public Class TypedResults
Наследование
TypedResults

Свойства

Имя Описание
Empty

Создает пустой ответ результата, что при выполнении ничего не будет делать.

Extensions

Предоставляет контейнер для внешних библиотек для расширения набора по умолчанию TypedResults с помощью собственных примеров.

Методы

Имя Описание
Accepted(String)

Status202Accepted Создает ответ.

Accepted(Uri)

Status202Accepted Создает ответ.

Accepted<TValue>(String, TValue)

Status202Accepted Создает ответ.

Accepted<TValue>(Uri, TValue)

Status202Accepted Создает ответ.

AcceptedAtRoute(String, Object)

Status202Accepted Создает ответ.

AcceptedAtRoute(String, RouteValueDictionary)

Status202Accepted Создает ответ.

AcceptedAtRoute<TValue>(TValue, String, Object)

Status202Accepted Создает ответ.

AcceptedAtRoute<TValue>(TValue, String, RouteValueDictionary)

Status202Accepted Создает ответ.

BadRequest()

Status400BadRequest Создает ответ.

BadRequest<TValue>(TValue)

Status400BadRequest Создает ответ.

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

Записывает содержимое массива байтов в ответ.

Это поддерживает запросы диапазона (Status206PartialContent или Status416RangeNotSatisfiable если диапазон не удовлетворяется).

Этот API является псевдонимом для File(Byte[], String, String, Boolean, Nullable<DateTimeOffset>, EntityTagHeaderValue).

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

Записывает содержимое массива байтов в ответ.

Это поддерживает запросы диапазона (Status206PartialContent или Status416RangeNotSatisfiable если диапазон не удовлетворяется).

Challenge(AuthenticationProperties, IList<String>)

ChallengeHttpResult Создает это при вызове ChallengeAsync(HttpContext, String, AuthenticationProperties)выполнения.

Поведение этого метода зависит от используемого IAuthenticationService . Status401Unauthorized и Status403Forbidden являются одними из вероятных результатов состояния.

Conflict()

Status409Conflict Создает ответ.

Conflict<TValue>(TValue)

Status409Conflict Создает ответ.

Content(String, MediaTypeHeaderValue)

Записывает строку в content ответ HTTP.

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

Записывает строку в content ответ HTTP.

Это равносильно Text(String, String, Encoding, Nullable<Int32>).

Content(String, String, Encoding)

Записывает строку в content ответ HTTP.

Это равносильно Text(String, String, Encoding).

Created()

Status201Created Создает ответ.

Created(String)

Status201Created Создает ответ.

Created(Uri)

Status201Created Создает ответ.

Created<TValue>(String, TValue)

Status201Created Создает ответ.

Created<TValue>(Uri, TValue)

Status201Created Создает ответ.

CreatedAtRoute(String, Object)

Status201Created Создает ответ.

CreatedAtRoute(String, RouteValueDictionary)

Status201Created Создает ответ.

CreatedAtRoute<TValue>(TValue, String, Object)

Status201Created Создает ответ.

CreatedAtRoute<TValue>(TValue, String, RouteValueDictionary)

Status201Created Создает ответ.

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

Записывает содержимое массива байтов в ответ.

Это поддерживает запросы диапазона (Status206PartialContent или Status416RangeNotSatisfiable если диапазон не удовлетворяется).

Этот API является псевдонимом для Bytes(Byte[], String, String, Boolean, Nullable<DateTimeOffset>, EntityTagHeaderValue).

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

Записывает указанный Stream в ответ.

Это поддерживает запросы диапазона (Status206PartialContent или Status416RangeNotSatisfiable если диапазон не удовлетворяется).

Этот API является псевдонимом для Stream(Stream, String, String, Nullable<DateTimeOffset>, EntityTagHeaderValue, Boolean).

Forbid(AuthenticationProperties, IList<String>)

ForbidHttpResult Создает это при вызове ForbidAsync(HttpContext, String, AuthenticationProperties)выполнения.

По умолчанию при выполнении этого результата возвращается Status403Forbiddenзначение . Некоторые схемы проверки подлинности, такие как файлы cookie, преобразуются Status403Forbidden в перенаправление для отображения страницы входа.

InternalServerError()

Status500InternalServerError Создает ответ.

InternalServerError<TValue>(TValue)

Status500InternalServerError Создает ответ.

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

Создает объект JsonHttpResult<TValue> , сериализующий указанный data объект в JSON.

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

Создает объект JsonHttpResult<TValue> , сериализующий указанный data объект в JSON.

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

Создает объект JsonHttpResult<TValue> , сериализующий указанный data объект в JSON.

LocalRedirect(String, Boolean, Boolean)

Перенаправляется на указанный localUrlобъект.

NoContent()

Status204NoContent Создает ответ.

NotFound()

Status404NotFound Создает ответ.

NotFound<TValue>(TValue)

Status404NotFound Создает ответ.

Ok()

Status200OK Создает ответ.

Ok<TValue>(TValue)

Status200OK Создает ответ.

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

Записывает файл в указанный path ответ.

Это поддерживает запросы диапазона (Status206PartialContent или Status416RangeNotSatisfiable если диапазон не удовлетворяется).

Problem(ProblemDetails)

ProblemDetails Создает ответ.

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

ProblemDetails Создает ответ.

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

ProblemDetails Создает ответ.

Redirect(String, Boolean, Boolean)

Перенаправляется на указанный urlобъект.

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

Перенаправляется на указанный маршрут.

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

Перенаправляется на указанный маршрут.

ServerSentEvents(IAsyncEnumerable<String>, String)

ServerSentEventsResult<T> Создает ответ.

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

ServerSentEventsResult<T> Создает ответ.

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

ServerSentEventsResult<T> Создает ответ.

SignIn(ClaimsPrincipal, AuthenticationProperties, String)

SignInHttpResult Создает это при вызове SignInAsync(HttpContext, String, ClaimsPrincipal, AuthenticationProperties)выполнения.

SignOut(AuthenticationProperties, IList<String>)

SignOutHttpResult Создает это при вызове SignOutAsync(HttpContext, String, AuthenticationProperties)выполнения.

StatusCode(Int32)

StatusCodeHttpResult Создает объект, указав объектstatusCode.

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

Разрешает запись непосредственно в текст ответа.

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

Записывает содержимое указанного PipeReader в ответ.

Это поддерживает запросы диапазона (Status206PartialContent или Status416RangeNotSatisfiable если диапазон не удовлетворяется).

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

Записывает указанный Stream в ответ.

Это поддерживает запросы диапазона (Status206PartialContent или Status416RangeNotSatisfiable если диапазон не удовлетворяется).

Этот API является псевдонимом для File(Stream, String, String, Nullable<DateTimeOffset>, EntityTagHeaderValue, Boolean).

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

Записывает текстовое содержимое utf8Content UTF8 в ответ HTTP.

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

Записывает строку в content ответ HTTP.

Это псевдоним для Content(String, String, Encoding, Nullable<Int32>).

Text(String, String, Encoding)

Записывает строку в content ответ HTTP.

Это псевдоним для Content(String, String, Encoding).

Unauthorized()

Status401Unauthorized Создает ответ.

UnprocessableEntity()

Status422UnprocessableEntity Создает ответ.

UnprocessableEntity<TValue>(TValue)

Status422UnprocessableEntity Создает ответ.

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

Status400BadRequest Создает ответ со значениемHttpValidationProblemDetails.

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

Status400BadRequest Создает ответ со значениемHttpValidationProblemDetails.

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

Записывает файл в указанный path ответ.

Это поддерживает запросы диапазона (Status206PartialContent или Status416RangeNotSatisfiable если диапазон не удовлетворяется).

Применяется к