Edit

Share via

SPHttpClientBatchConfiguration class

  • Reference
Package:
@microsoft/sp-http-base

Note

This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.

Configuration for SPHttpClientBatch.

Extends
SPHttpClientCommonConfiguration

Remarks

The SPHttpClientBatchConfiguration object provides a set of switches for enabling/disabling various features of the SPHttpClientBatch class. Normally these switches are set (e.g. when calling SPHttpClientBatch.fetch()) by providing one of the predefined defaults from SPHttpClientBatchConfigurations, however switches can also be changed via the SPHttpClientBatchConfiguration.overrideWith() method.

Constructors

(constructor)(flags, overrideFlags)

Constructs a new instance of SPHttpClientBatchConfiguration with the specified flags. The default values will be used for any flags that are missing or undefined. If overrideFlags is specified, it takes precedence over flags.

Properties

flags

Methods

initializeFlags()
overrideWith(sourceFlags)

Constructor Details

(constructor)(flags, overrideFlags)

Note

This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.

Constructs a new instance of SPHttpClientBatchConfiguration with the specified flags. The default values will be used for any flags that are missing or undefined. If overrideFlags is specified, it takes precedence over flags.

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

Parameters

flags
ISPHttpClientBatchConfiguration
overrideFlags
ISPHttpClientBatchConfiguration

Property Details

flags

Note

This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.

protected flags: ISPHttpClientBatchConfiguration;

Property Value

ISPHttpClientBatchConfiguration

Method Details

initializeFlags()

Note

This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.

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

Returns

void

overrideWith(sourceFlags)

Note

This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.

/** @override */
overrideWith(sourceFlags: ISPHttpClientBatchConfiguration): SPHttpClientBatchConfiguration;

Parameters

sourceFlags
ISPHttpClientBatchConfiguration

Returns

SPHttpClientBatchConfiguration