Edit

Share via

SPHttpClientResponse class

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

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

Extends
HttpClientResponse

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

User-friendly status message that includes the HTTP status, with the correlation id and version of the server.

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.

statusMessage

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.

User-friendly status message that includes the HTTP status, with the correlation id and version of the server.

get statusMessage(): string;

Property Value

string

Method Details

clone() 

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

Returns

SPHttpClientResponse