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


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

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.

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)

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

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, если диапазон не удовлетворяется).

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