SPHttpClientCommonConfiguration class

包:: @microsoft/sp-http-base

SPHttpClientConfiguration 和 SPHttpClientBatchConfiguration 的通用基类。

扩展: HttpClientConfiguration

构造函数

构建具有指定标志的 SPHttpClientCommonConfiguration 的新实例。

属性

flags
jsonRequest	自动为 JSON 有效负载配置“Content-Type”标头。
jsonResponse	自动为 JSON 有效负载配置“Accept”标头。

方法

initializeFlags()
overrideWith(sourceFlags)

构造函数详细信息

(constructor)(flags, overrideFlags)

构建具有指定标志的 SPHttpClientCommonConfiguration 的新实例。

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

参数

flags: ISPHttpClientCommonConfiguration

overrideFlags: ISPHttpClientCommonConfiguration

注解

默认值将被用于任何缺失或未定义的标志。如果指定了 overrideFlags，则它优先于标志。

属性详细信息

flags

protected flags: ISPHttpClientCommonConfiguration;

属性值

ISPHttpClientCommonConfiguration

jsonRequest

自动为 JSON 有效负载配置“Content-Type”标头。

get jsonRequest(): boolean;

属性值

boolean

注解

当此开关为 true 时：

如果未为请求显式添加“Content-Type”标头，则如果请求是写入操作 (（即“GET”、“HEAD”或“OPTIONS”) 以外的 HTTP 方法），则 SPHttpClient 将添加该标头。

对于 OData 3.0，值为 “application/json;odata=verbose;charset=utf-8”。

对于 OData 4.0，值为 “application/json;charset=utf-8”。

jsonResponse

自动为 JSON 有效负载配置“Accept”标头。

get jsonResponse(): boolean;

属性值

boolean

注解

当此开关为 true 时：

如果未为请求显式添加“Accept”标头，则 SPHttpClient 将添加它。

对于 OData 3.0，值为“application/json”。

对于 OData 4.0，值为“application/json;odata.metadata=minimal”。

方法详细信息

initializeFlags()

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

void

overrideWith(sourceFlags)

/** @override */
overrideWith(sourceFlags: ISPHttpClientCommonConfiguration): SPHttpClientCommonConfiguration;

参数

sourceFlags: ISPHttpClientCommonConfiguration

SPHttpClientCommonConfiguration

通过