TypedResults クラス

定義

の型に対する IResultMicrosoft.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 異なります。 Status401UnauthorizedStatus403Forbidden は、可能性の高い状態の結果の 1 つです。

Conflict()

応答を Status409Conflict 生成します。

Conflict<TValue>(TValue)

応答を Status409Conflict 生成します。

Content(String, MediaTypeHeaderValue)

HTTP 応答に content 文字列を書き込みます。

Content(String, String, Encoding)

HTTP 応答に content 文字列を書き込みます。

これは、Text(String, String, Encoding) と同じです。

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

HTTP 応答に content 文字列を書き込みます。

これは、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>)

指定したdataオブジェクトを JsonHttpResult<TValue> JSON にシリアル化する を作成します。

Json<TValue>(TValue, JsonSerializerOptions, String, Nullable<Int32>)

指定したdataオブジェクトを JsonHttpResult<TValue> JSON にシリアル化する を作成します。

Json<TValue>(TValue, JsonTypeInfo<TValue>, String, Nullable<Int32>)

指定したdataオブジェクトを JsonHttpResult<TValue> 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>)

UTF8 テキスト コンテンツを utf8Content HTTP 応答に書き込みます。

Text(String, String, Encoding)

HTTP 応答に content 文字列を書き込みます。

これは のエイリアス Content(String, String, Encoding)です。

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

HTTP 応答に content 文字列を書き込みます。

これは のエイリアス 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 範囲が満たされない場合) がサポートされます。

適用対象