HttpBaseProtocolFilter クラス

リファレンス

定義

名前空間:: Windows.Web.Http.Filters

重要

一部の情報は、リリース前に大きく変更される可能性があるプレリリースされた製品に関するものです。 Microsoft は、ここに記載されている情報について、明示または黙示を問わず、一切保証しません。

編集

HttpClient インスタンスの基本プロトコルフィルター。

public ref class HttpBaseProtocolFilter sealed : IClosable

public ref class HttpBaseProtocolFilter sealed : IClosable, IHttpFilter

/// [Windows.Foundation.Metadata.Activatable(65536, Windows.Foundation.UniversalApiContract)]
/// [Windows.Foundation.Metadata.ContractVersion(Windows.Foundation.UniversalApiContract, 65536)]
/// [Windows.Foundation.Metadata.MarshalingBehavior(Windows.Foundation.Metadata.MarshalingType.Agile)]
/// [Windows.Foundation.Metadata.Threading(Windows.Foundation.Metadata.ThreadingModel.Both)]
class HttpBaseProtocolFilter final : IClosable

/// [Windows.Foundation.Metadata.ContractVersion(Windows.Foundation.UniversalApiContract, 65536)]
/// [Windows.Foundation.Metadata.MarshalingBehavior(Windows.Foundation.Metadata.MarshalingType.Agile)]
/// [Windows.Foundation.Metadata.Threading(Windows.Foundation.Metadata.ThreadingModel.Both)]
/// [Windows.Foundation.Metadata.Activatable(65536, "Windows.Foundation.UniversalApiContract")]
class HttpBaseProtocolFilter final : IClosable

/// [Windows.Foundation.Metadata.ContractVersion(Windows.Foundation.UniversalApiContract, 65536)]
/// [Windows.Foundation.Metadata.MarshalingBehavior(Windows.Foundation.Metadata.MarshalingType.Agile)]
/// [Windows.Foundation.Metadata.Threading(Windows.Foundation.Metadata.ThreadingModel.Both)]
/// [Windows.Foundation.Metadata.Activatable(65536, "Windows.Foundation.UniversalApiContract")]
class HttpBaseProtocolFilter final : IClosable, IHttpFilter

[Windows.Foundation.Metadata.Activatable(65536, typeof(Windows.Foundation.UniversalApiContract))]
[Windows.Foundation.Metadata.ContractVersion(typeof(Windows.Foundation.UniversalApiContract), 65536)]
[Windows.Foundation.Metadata.MarshalingBehavior(Windows.Foundation.Metadata.MarshalingType.Agile)]
[Windows.Foundation.Metadata.Threading(Windows.Foundation.Metadata.ThreadingModel.Both)]
public sealed class HttpBaseProtocolFilter : System.IDisposable

[Windows.Foundation.Metadata.ContractVersion(typeof(Windows.Foundation.UniversalApiContract), 65536)]
[Windows.Foundation.Metadata.MarshalingBehavior(Windows.Foundation.Metadata.MarshalingType.Agile)]
[Windows.Foundation.Metadata.Threading(Windows.Foundation.Metadata.ThreadingModel.Both)]
[Windows.Foundation.Metadata.Activatable(65536, "Windows.Foundation.UniversalApiContract")]
public sealed class HttpBaseProtocolFilter : System.IDisposable

[Windows.Foundation.Metadata.ContractVersion(typeof(Windows.Foundation.UniversalApiContract), 65536)]
[Windows.Foundation.Metadata.MarshalingBehavior(Windows.Foundation.Metadata.MarshalingType.Agile)]
[Windows.Foundation.Metadata.Threading(Windows.Foundation.Metadata.ThreadingModel.Both)]
[Windows.Foundation.Metadata.Activatable(65536, "Windows.Foundation.UniversalApiContract")]
public sealed class HttpBaseProtocolFilter : System.IDisposable, IHttpFilter

function HttpBaseProtocolFilter()

Public NotInheritable Class HttpBaseProtocolFilter
Implements IDisposable

Public NotInheritable Class HttpBaseProtocolFilter
Implements IDisposable, IHttpFilter

継承: Object Platform::Object IInspectable HttpBaseProtocolFilter

属性: ActivatableAttribute ContractVersionAttribute MarshalingBehaviorAttribute ThreadingAttribute

実装: IClosable IDisposable IHttpFilter

Windows の要件

デバイスファミリ	Windows 10 (10.0.10240.0 で導入)
API contract	Windows.Foundation.UniversalApiContract (v1.0 で導入)

注釈

HttpBaseProtocolFilter クラスは、 HttpClient インスタンスによって使用される基本フィルターまたはハンドラーを提供します。 HttpClient インスタンスに追加のフィルターが追加されない場合は、HttpBaseProtocolFilter オブジェクトのみがフィルターになります。

HttpBaseProtocolFilter クラスには、さまざまな低レベル HTTP スタック動作を切り替える一連のプロパティが用意されています。

IHttpFilter インターフェイスに基づく追加のフィルターは、HttpBaseProtocolFilter オブジェクトの結果をさらに処理または処理できる HttpClient インスタンスに適用されるフィルターチェーンに追加できます。

HttpBaseProtocolFilter オブジェクトは、HTTP 要求の送信または応答の受信時に例外をスローし、ネットワークエラーが発生します (たとえば、飛行機モードでの接続の損失)。アプリで HttpClient を使用する開発者は、これらの例外をキャッチし、代わりに HTTP 応答コードに変換するフィルターを追加することを好む場合があります。

バージョン履歴

Windows のバージョン	SDK バージョン	追加された値
1511	10586	CookieUsageBehavior
1607	14393	ClearAuthenticationCache
1607	14393	ServerCustomValidationRequested
1903	18362	CreateForUser
1903	18362	User

コンストラクター

HttpBaseProtocolFilter()

HttpBaseProtocolFilter クラスの新しいインスタンスを初期化します。

デスクトップアプリでは、UI を表示する方法でこのクラスのインスタンスを使用する前に、オブジェクトを所有者のウィンドウハンドルに関連付ける必要があります。詳細とコード例については、「 CoreWindow に依存する WinRT UI オブジェクトを表示する」を参照してください。

プロパティ

AllowAutoRedirect	HttpBaseProtocolFilter がリダイレクト応答に従う必要があるかどうかを示す値を取得または設定します。
AllowUI	サーバーから要求されたときに HttpBaseProtocolFilter がユーザー資格情報の入力を求めることができるかどうかを示す値を取得または設定します。
AutomaticDecompression	HttpBaseProtocolFilter が HTTP コンテンツ応答を自動的に圧縮解除できるかどうかを示す値を取得または設定します。
CacheControl	HttpBaseProtocolFilter オブジェクトで使用される読み取りおよび書き込みキャッシュ制御の動作を取得または設定します。
ClientCertificate	サーバーがクライアント証明書を要求した場合にサーバーに送信されるクライアント SSL 証明書を取得または設定します。
CookieManager	アプリに関連付けられている Cookie を使用して HttpCookieManager を取得します。
CookieUsageBehavior	Cookie の使用動作を取得または設定します。既定では、Cookie は自動的に処理されます。
IgnorableServerCertificateErrors	アプリが後で無視することを選択する可能性がある SSL サーバー証明書エラーのベクトルを取得します。
MaxConnectionsPerServer	HttpBaseProtocolFilter オブジェクトによって HTTP サーバーごとに許可される TCP 接続の最大数を取得または設定します。
MaxVersion	使用する HTTP プロトコルのバージョンを取得または設定します。
ProxyCredential	HTTP プロキシとのネゴシエートに使用する資格情報を取得または設定します。
ServerCredential	HTTP サーバーでの認証に使用する資格情報を取得または設定します。
UseProxy	HttpBaseProtocolFilter が HTTP 要求の送信にプロキシを使用できるかどうかを示す値を取得または設定します。
User	HttpBaseProtocolFilter に関連付けられているユーザーを取得します。

メソッド

ClearAuthenticationCache()	デバイスに現在キャッシュされている認証資格情報をクリアします。
Close()	HttpBaseProtocolFilter インスタンスを閉じ、割り当てられたリソースを解放します。
CreateForUser(User)	特定のユーザーの新しい HttpBaseProtocolFilter を作成します。
Dispose()	アンマネージリソースの解放またはリセットに関連付けられているアプリケーション定義のタスクを実行します。
SendRequestAsync(HttpRequestMessage)	HttpBaseProtocolFilter を非同期操作として使用して HTTP 要求を送信します。

イベント

ServerCustomValidationRequested

このイベントは、サーバーとの SSL/TLS 接続が確立されるときに発生します。サーバー SSL 証明書の追加の検証 (OS の既定値に加えて) を実行する必要がある場合は、このイベントのイベントハンドラーを実装する必要があります。

適用対象

次の方法で共有