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)

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

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

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

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

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

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 в перенаправление для отображения страницы входа.

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 ответ.

Redirect(String, Boolean, Boolean)

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

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

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

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

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

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)

Позволяет выполнять запись непосредственно в текст ответа.

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

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)

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

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

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

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

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

Unauthorized()

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

UnprocessableEntity()

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

UnprocessableEntity<TValue>(TValue)

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

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

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

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

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

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

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