SPHttpClientResponse class

The Response subclass returned by methods such as SPHttpClient.fetch().

Extends
@microsoft/sp-http!default:class

Remarks

This class is marked as @sealed. Subclasses should not extend it.

This is a placeholder. In the future, additional SPHttpClient-specific functionality may be added to this class.

Constructors

(constructor)(response)

Constructs a new instance of the SPHttpClientResponse class

Properties

correlationId

Returns the SharePoint correlation ID.

Methods

clone()

Constructor Details

(constructor)(response)

Constructs a new instance of the SPHttpClientResponse class

constructor(response: Response);

Parameters

response

Response

Property Details

correlationId

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.

Returns the SharePoint correlation ID.

get correlationId(): Guid | undefined;

Property Value

Guid | undefined

Remarks

The correlation ID is a Guid that can be used to associate log events that are part of the same overall operation, but may originate from different services or components. SharePoint REST operations return the server's correlation ID as the "sprequestguid" header.

Method Details

clone()

/** @override */
clone(): SPHttpClientResponse;

Returns

@microsoft/sp-http!default:class