Edit

ISPHttpClientBatchCreationOptions interface

  • 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.

This interface is passed to the SPHttpClientBatch constructor. It specifies options that affect the entire batch.

Properties

webUrl

SPHttpClientBatch will need to perform its POST to an endpoint such as "http://example.com/sites/sample/_api/$batch". Typically the SPWeb URL ("https://example.com/sites/sample" in this example) can be guessed by looking for a reserved URL segment such as "_api" in the first URL passed to fetch(), but if not, the webUrl can be explicitly specified using this option.

Property Details

webUrl

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.

SPHttpClientBatch will need to perform its POST to an endpoint such as "http://example.com/sites/sample/_api/$batch". Typically the SPWeb URL ("https://example.com/sites/sample" in this example) can be guessed by looking for a reserved URL segment such as "_api" in the first URL passed to fetch(), but if not, the webUrl can be explicitly specified using this option.

webUrl?: string;

Property Value

string