TypedResults 類別

定義

Microsoft.AspNetCore.Http.HttpResults 類型的具型別處理站 IResult

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 使用中的 。 Status401UnauthorizedStatus403Forbidden 在可能的狀態結果之間。

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)

藉由指定 statusCode 來建立 StatusCodeHttpResult 物件。

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 範圍無法滿足) 。

適用於