次の方法で共有


SPHttpClientConfiguration class

SPHttpClient の構成。

Extends

注釈

SPHttpClientConfiguration オブジェクトは、SPHttpClient クラスのさまざまな機能を有効化/無効化するスイッチのセットを提供します。 通常、これらのスイッチは (たとえば、SPHttpClient.fetch() を呼び出すときには)、事前定義済みの既定値を SPHttpClientConfigurations から指定することで設定されますが、SPHttpClientConfiguration.overrideWith() メソッドによってスイッチを変更することもできます。

コンストラクター

(constructor)(flags, overrideFlags)

指定されたフラグが設定された SPHttpClientConfiguration の新しいインスタンスを作成します。 既定値は、欠落しているフラグまたは未定義のフラグに使用されます。 overrideFlags が指定されている場合は、フラグよりも優先されます。

プロパティ

defaultODataVersion

"OData-Version" ヘッダーを自動的に構成します。

defaultSameOriginCredentials

RequestInit.credentials を自動的に構成します。

flags
requestDigest

認証用の "X-RequestDigest" ヘッダーを自動的に指定します。

メソッド

initializeFlags()
overrideWith(sourceFlags)

コンストラクターの詳細

(constructor)(flags, overrideFlags)

指定されたフラグが設定された SPHttpClientConfiguration の新しいインスタンスを作成します。 既定値は、欠落しているフラグまたは未定義のフラグに使用されます。 overrideFlags が指定されている場合は、フラグよりも優先されます。

constructor(flags: ISPHttpClientConfiguration, overrideFlags?: ISPHttpClientConfiguration);

パラメーター

プロパティの詳細

defaultODataVersion

"OData-Version" ヘッダーを自動的に構成します。

get defaultODataVersion(): ODataVersion;

プロパティ値

注釈

このスイッチが指定されている場合 (つまり、未定義ではありません): 要求に対して "OData-Version" ヘッダーが明示的に追加されていない場合、SPHttpClient はヘッダーを追加して defaultODataVersion で示されるバージョンを指定します。

注:現時点では、'OData-Version' ヘッダーがないときには、ほとんどの場合に SharePoint サーバーはバージョンバージョン 3.0 を既定値にします。 推奨されるバージョンは 4.0 です。

defaultSameOriginCredentials

RequestInit.credentials を自動的に構成します。

get defaultSameOriginCredentials(): boolean;

プロパティ値

boolean

注釈

このスイッチが true の場合:

RequestInit.credentials が要求に対して明示的に指定されていない場合、SPHttpClient はそれを "同じ配信元" に割り当てます。 このスイッチがない場合は、ブラウザーごとに異なる既定値が適用されます。

詳細については、仕様を参照してください (https://fetch.spec.whatwg.org/\#cors-protocol-and-credentials

flags

protected flags: ISPHttpClientConfiguration;

プロパティ値

requestDigest

認証用の "X-RequestDigest" ヘッダーを自動的に指定します。

get requestDigest(): boolean;

プロパティ値

boolean

注釈

このスイッチが true の場合:

要求に対して "X-RequestDigest" ヘッダーが明示的に追加されていない場合、要求が書き込み操作 (つまり、"GET"、"HEAD"、または "OPTIONS" 以外の HTTP メソッド) である場合、SPHttpClient によって追加されます。 リクエスト ダイジェストは、DigestCache サービスで管理されます。 キャッシュ ミスの場合は、追加のネットワーク リクエストが実行されることがあります。

メソッドの詳細

initializeFlags()

/** @override */
protected initializeFlags(): void;

戻り値

void

overrideWith(sourceFlags)

/** @override */
overrideWith(sourceFlags: ISPHttpClientConfiguration): SPHttpClientConfiguration;

パラメーター

戻り値