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 は、可能性の高い状態の結果の 1 つです。
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>)	指定した data オブジェクトを JSON にシリアル化する JsonHttpResult<TValue> を作成します。
Json<TValue>(TValue, JsonSerializerOptions, String, Nullable<Int32>)	指定した data オブジェクトを JSON にシリアル化する JsonHttpResult<TValue> を作成します。
Json<TValue>(TValue, JsonTypeInfo<TValue>, String, Nullable<Int32>)	指定した data オブジェクトを JSON にシリアル化する JsonHttpResult<TValue> を作成します。
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)	応答本文に直接書き込みを許可します。 これにより、範囲要求がサポートされます (範囲が満たされない場合は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>)	HttpValidationProblemDetails 値を持つ Status400BadRequest 応答を生成します。
VirtualFile(String, String, String, Nullable<DateTimeOffset>, EntityTagHeaderValue, Boolean)	指定した path のファイルを応答に書き込みます。 これにより、範囲要求がサポートされます (範囲が満たされない場合はStatus206PartialContent または Status416RangeNotSatisfiable)。