ISPHttpClientConfiguration interface
SPHttpClientConfiguration のフラグ インターフェイス。
- Extends
プロパティ
default |
"OData-Version" ヘッダーを自動的に構成します。 |
default |
RequestInit.credentials を自動的に構成します。 |
request |
認証用の "X-RequestDigest" ヘッダーを自動的に指定します。 |
プロパティの詳細
defaultODataVersion
"OData-Version" ヘッダーを自動的に構成します。
defaultODataVersion?: ODataVersion;
プロパティ値
注釈
このスイッチが指定されている場合 (つまり、未定義ではありません): 要求に対して "OData-Version" ヘッダーが明示的に追加されていない場合、SPHttpClient はヘッダーを追加して defaultODataVersion で示されるバージョンを指定します。
注:現時点では、'OData-Version' ヘッダーがないときには、ほとんどの場合に SharePoint サーバーはバージョンバージョン 3.0 を既定値にします。 推奨されるバージョンは 4.0 です。
defaultSameOriginCredentials
RequestInit.credentials を自動的に構成します。
defaultSameOriginCredentials?: boolean;
プロパティ値
boolean
注釈
このスイッチが true の場合:
RequestInit.credentials が要求に対して明示的に指定されていない場合、SPHttpClient はそれを "同じ配信元" に割り当てます。 このスイッチがない場合は、ブラウザーごとに異なる既定値が適用されます。
詳細については、仕様を参照してください (https://fetch.spec.whatwg.org/\#cors-protocol-and-credentials。
requestDigest
認証用の "X-RequestDigest" ヘッダーを自動的に指定します。
requestDigest?: boolean;
プロパティ値
boolean
注釈
このスイッチが true の場合:
要求に対して "X-RequestDigest" ヘッダーが明示的に追加されていない場合、要求が書き込み操作 (つまり、"GET"、"HEAD"、または "OPTIONS" 以外の HTTP メソッド) である場合、SPHttpClient によって追加されます。 リクエスト ダイジェストは、DigestCache サービスで管理されます。 キャッシュ ミスの場合は、追加のネットワーク リクエストが実行されることがあります。