SPHttpClientConfiguration class
SPHttpClient 的配置。
- 扩展
注解
SPHttpClientConfiguration 对象提供一组用于启用/禁用 SPHttpClient 类的各种功能的开关。 通常，通过提供来自 SPHttpClientConfigurations 的预定义默认值之一来设置这些开关（例如，调用 SPHttpClient.fetch() 时），但也可以通过 SPHttpClientConfiguration.overrideWith() 方法更改开关。
构造函数
| (constructor)(flags, override |
构建具有指定标志的 SPHttpClientConfiguration 的新实例。 默认值将被用于任何缺失或未定义的标志。 如果指定了 overrideFlags，则它优先于标志。 |
属性
| default |
自动配置“OData-Version”标头。 |
| default |
自动配置 RequestInit.credentials。 |
| flags | |
| request |
自动提供用于身份验证的“X-RequestDigest”标头。 |
方法
| initialize |
|
| override |
构造函数详细信息
(constructor)(flags, overrideFlags)
构建具有指定标志的 SPHttpClientConfiguration 的新实例。 默认值将被用于任何缺失或未定义的标志。 如果指定了 overrideFlags，则它优先于标志。
constructor(flags: ISPHttpClientConfiguration, overrideFlags?: ISPHttpClientConfiguration);参数
- overrideFlags
- ISPHttpClientConfiguration
属性详细信息
defaultODataVersion
自动配置“OData-Version”标头。
get defaultODataVersion(): ODataVersion;属性值
注解
当指定此开关 (即未定义) 时：如果未为请求显式添加“OData-Version”标头，则 SPHttpClient 将添加标头以指定默认的 ODataVersion 指示的版本。
注意：如果没有“OData-Version”标头，则 SharePoint 服务器在大多数情况下将默认为 3.0 版本。 建议使用的版本是 4.0。
defaultSameOriginCredentials
自动配置 RequestInit.credentials。
get defaultSameOriginCredentials(): boolean;属性值
boolean
注解
当此开关为 true 时：
如果未为请求显式指定 RequestInit.credentials，则 SPHttpClient 会将它指定为“同源”。 如果没有此开关，不同的 Web 浏览器可能应用不同的默认值。
有关详细信息，请参阅规范： https://fetch.spec.whatwg.org/\#cors-protocol-and-credentials
flags
requestDigest
自动提供用于身份验证的“X-RequestDigest”标头。
get requestDigest(): boolean;属性值
boolean
注解
当此开关为 true 时：
如果未为请求显式添加“X-RequestDigest”标头，则如果请求是写入操作，则 SPHttpClient 将添加该标头 (即“GET”、“HEAD”或“OPTIONS”) 以外的 HTTP 方法。 请求摘要由 DigestCache 服务进行管理。 在缓存缺失的情况下，可能需要执行其他网络请求。
方法详细信息
initializeFlags()
/** @override */
protected initializeFlags(): void;返回
void
overrideWith(sourceFlags)
/** @override */
overrideWith(sourceFlags: ISPHttpClientConfiguration): SPHttpClientConfiguration;参数
- sourceFlags
- ISPHttpClientConfiguration