TypedResults 類別

定義

命名空間:

Microsoft.AspNetCore.Http

組件:

Microsoft.AspNetCore.Http.Results.dll

套件:

Microsoft.AspNetCore.App.Ref v8.0.0

來源:

TypedResults.cs

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

public static class TypedResults

type TypedResults = class

Public Class TypedResults

繼承

Object

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>)	建立執行時叫用 ChallengeAsync(HttpContext, String, AuthenticationProperties)的 ChallengeHttpResult。 此方法的行為取決於使用中的 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>)	建立執行時叫用 ForbidAsync(HttpContext, String, AuthenticationProperties)的 ForbidHttpResult。 根據預設，執行此結果會傳回 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。 設定 permanent 和 preserveMethod 時，請設定 Status308PermanentRedirect 狀態代碼。 設定 preserveMethod 時，設定 Status307TemporaryRedirect 狀態代碼。 設定 permanent 時，設定 Status301MovedPermanently 狀態代碼。
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。 設定 permanent 和 preserveMethod 時，請設定 Status308PermanentRedirect 狀態代碼。 設定 preserveMethod 時，設定 Status307TemporaryRedirect 狀態代碼。 設定 permanent 時，設定 Status301MovedPermanently 狀態代碼。
RedirectToRoute(String, Object, Boolean, Boolean, String)	重新導向至指定的路由。 設定 permanent 和 preserveMethod 時，請設定 Status308PermanentRedirect 狀態代碼。 設定 preserveMethod 時，設定 Status307TemporaryRedirect 狀態代碼。 設定 permanent 時，設定 Status301MovedPermanently 狀態代碼。 否則，請設定 Status302Found。
RedirectToRoute(String, RouteValueDictionary, Boolean, Boolean, String)	重新導向至指定的路由。 設定 permanent 和 preserveMethod 時，請設定 Status308PermanentRedirect 狀態代碼。 設定 preserveMethod 時，設定 Status307TemporaryRedirect 狀態代碼。 設定 permanent 時，設定 Status301MovedPermanently 狀態代碼。 否則，請設定 Status302Found。
SignIn(ClaimsPrincipal, AuthenticationProperties, String)	建立執行時叫用 SignInAsync(HttpContext, String, ClaimsPrincipal, AuthenticationProperties)的 SignInHttpResult。
SignOut(AuthenticationProperties, IList<String>)	建立執行時叫用 SignOutAsync(HttpContext, String, AuthenticationProperties)的 SignOutHttpResult。
StatusCode(Int32)	藉由指定 statusCode來建立 StatusCodeHttpResult 物件。
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>)	產生具有 HttpValidationProblemDetails 值的 Status400BadRequest 回應。
VirtualFile(String, String, String, Nullable<DateTimeOffset>, EntityTagHeaderValue, Boolean)	將位於指定 path 的檔案寫入回應。 這支援範圍要求（如果無法滿足範圍，Status206PartialContent 或 Status416RangeNotSatisfiable）。