Results Класс

  • Ссылка

Определение

Пространство имен:
Microsoft.AspNetCore.Http
Сборка:
Microsoft.AspNetCore.Http.Results.dll
Пакет:
Microsoft.AspNetCore.App.Ref v6.0.6
Пакет:
Microsoft.AspNetCore.App.Ref v7.0.5
Пакет:
Microsoft.AspNetCore.App.Ref v8.0.0
Пакет:
Microsoft.AspNetCore.App.Ref v9.0.0-preview.6.24328.4
Исходный код:
Results.cs

Фабрика для IResult.

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

Свойства

Empty

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

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

Методы

Accepted(String, Object)

Создает ответ Status202Accepted.
Accepted<TValue>(String, TValue)

Создает ответ Status202Accepted.
AcceptedAtRoute(String, Object, Object)

Создает ответ Status202Accepted.
AcceptedAtRoute(String, RouteValueDictionary, Object)

Создает ответ Status202Accepted.
AcceptedAtRoute<TValue>(String, Object, TValue)

Создает ответ Status202Accepted.
AcceptedAtRoute<TValue>(String, RouteValueDictionary, TValue)

Создает ответ Status202Accepted.
BadRequest(Object)

Создает ответ 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>)

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

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

Conflict(Object)

Создает ответ 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, Object)

Создает ответ Status201Created.
Created(Uri, Object)

Создает ответ Status201Created.
Created<TValue>(String, TValue)

Создает ответ Status201Created.
Created<TValue>(Uri, TValue)

Создает ответ Status201Created.
CreatedAtRoute(String, Object, Object)

Создает ответ Status201Created.
CreatedAtRoute(String, RouteValueDictionary, Object)

Создает ответ Status201Created.
CreatedAtRoute<TValue>(String, Object, TValue)

Создает ответ Status201Created.
CreatedAtRoute<TValue>(String, RouteValueDictionary, TValue)

Создает ответ 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).

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

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

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

Forbid(AuthenticationProperties, IList<String>)

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

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

InternalServerError()

Создает ответ Status500InternalServerError.
InternalServerError<TValue>(TValue)

Создает ответ Status500InternalServerError.
Json(Object, JsonSerializerOptions, String, Nullable<Int32>)

Создает IResult, который сериализует указанный объект data в JSON.
Json(Object, JsonTypeInfo, String, Nullable<Int32>)

Создает IResult, который сериализует указанный объект data в JSON.
Json(Object, Type, JsonSerializerContext, String, Nullable<Int32>)

Создает IResult, который сериализует указанный объект data в JSON.
Json<TValue>(TValue, JsonSerializerContext, String, Nullable<Int32>)

Создает IResult, который сериализует указанный объект data в JSON.
Json<TValue>(TValue, JsonSerializerOptions, String, Nullable<Int32>)

Создает IResult, который сериализует указанный объект data в JSON.
Json<TValue>(TValue, JsonTypeInfo<TValue>, String, Nullable<Int32>)

Создает IResult, который сериализует указанный объект data в JSON.
LocalRedirect(String, Boolean, Boolean)

Перенаправляется на указанный localUrl.
NoContent()

Создает ответ Status204NoContent.
NotFound(Object)

Создает ответ Status404NotFound.
NotFound<TValue>(TValue)

Создает ответ Status404NotFound.
Ok(Object)

Создает ответ Status200OK.
Ok<TValue>(TValue)

Создает ответ Status200OK.
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)

Создает IResult, которая при выполнении вызывает SignInAsync(HttpContext, String, ClaimsPrincipal, AuthenticationProperties).
SignOut(AuthenticationProperties, IList<String>)

Создает IResult, которая при выполнении вызывает SignOutAsync(HttpContext, String, AuthenticationProperties).
StatusCode(Int32)

Создает объект IResult путем указания 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>)

Записывает в ответ HTTP utf8Content кодировку UTF-8.
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(Object)

Создает ответ Status422UnprocessableEntity.
UnprocessableEntity<TValue>(TValue)

Создает ответ Status422UnprocessableEntity.
ValidationProblem(IDictionary<String,String[]>, String, String, Nullable<Int32>, String, String, IDictionary<String,Object>)

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

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