SPHttpClientConfiguration class

Paket:

@microsoft/sp-http-base

Konfiguration für SPHttpClient.

Extends

SPHttpClientCommonConfiguration

Hinweise

Das SPHttpClientConfiguration-Objekt stellt eine Reihe von Optionen zum Aktivieren/Deaktivieren verschiedener Features der SPHttpClient-Klasse bereit. Normalerweise werden diese Schalter festgelegt (z. B. beim Aufrufen von SPHttpClient.fetch()), indem eine der vordefinierten Standardwerte aus SPHttpClientConfigurations bereitgestellt wird. Switches können jedoch auch über die SPHttpClientConfiguration.overrideWith()-Methode geändert werden.

Konstruktoren

(constructor)(flags, overrideFlags)

Erstellt eine neue Instanz von SPHttpClientConfiguration mit den angegebenen Flags. Die Standardwerte werden für alle Flags verwendet, die fehlen oder nicht definiert sind. Wenn overrideFlags angegeben wird, hat dies Vorrang vor Flags.

Eigenschaften

defaultODataVersion	Konfigurieren Sie den Header "OData-Version" automatisch.
defaultSameOriginCredentials	Konfigurieren Sie requestInit.credentials automatisch.
flags
requestDigest	Stellen Sie automatisch einen "X-RequestDigest"-Header für die Authentifizierung bereit.

Methoden

initializeFlags()
overrideWith(sourceFlags)

Details zum Konstruktor

(constructor)(flags, overrideFlags)

Erstellt eine neue Instanz von SPHttpClientConfiguration mit den angegebenen Flags. Die Standardwerte werden für alle Flags verwendet, die fehlen oder nicht definiert sind. Wenn overrideFlags angegeben wird, hat dies Vorrang vor Flags.

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

Parameter

flags

ISPHttpClientConfiguration

overrideFlags

ISPHttpClientConfiguration

Details zur Eigenschaft

defaultODataVersion

Konfigurieren Sie den Header "OData-Version" automatisch.

get defaultODataVersion(): ODataVersion;

Eigenschaftswert

ODataVersion

Hinweise

Wenn dieser Schalter angegeben ist (d. h. nicht undefiniert): Wenn der Header "OData-Version" nicht explizit für die Anforderung hinzugefügt wurde, fügt SPHttpClient den Header hinzu, um die von defaultODataVersion angegebene Version anzugeben.

HINWEIS: Ohne einen OData-Version-Header wird der SharePoint-Server in den meisten Fällen standardmäßig auf Version 3.0 festgelegt. Die empfohlene Version ist 4.0.

defaultSameOriginCredentials

Konfigurieren Sie requestInit.credentials automatisch.

get defaultSameOriginCredentials(): boolean;

Eigenschaftswert

boolean

Hinweise

Wenn dieser Schalter true ist:

Wenn RequestInit.credentials nicht explizit für die Anforderung angegeben ist, weist SPHttpClient sie als "same-origin" zu. Ohne diesen Schalter können unterschiedliche Webbrowser unterschiedliche Standardwerte anwenden.

Weitere Informationen finden Sie in der Spezifikation: https://fetch.spec.whatwg.org/\#cors-protocol-and-credentials

flags

protected flags: ISPHttpClientConfiguration;

Eigenschaftswert

ISPHttpClientConfiguration

requestDigest

Stellen Sie automatisch einen "X-RequestDigest"-Header für die Authentifizierung bereit.

get requestDigest(): boolean;

Eigenschaftswert

boolean

Hinweise

Wenn dieser Schalter true ist:

Wenn der Header "X-RequestDigest" für die Anforderung nicht explizit hinzugefügt wurde, fügt SPHttpClient ihn hinzu, wenn die Anforderung ein Schreibvorgang ist (d. h. eine andere HTTP-Methode als "GET", "HEAD" oder "OPTIONS"). Der Anforderungsdigest wird vom DigestCache-Dienst verwaltet. Im Falle eines Cachefehlers kann eine zusätzliche Netzwerkanforderung ausgeführt werden.

Details zur Methode

initializeFlags()

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

Gibt zurück

void

overrideWith(sourceFlags)

/** @override */
overrideWith(sourceFlags: ISPHttpClientConfiguration): SPHttpClientConfiguration;

Parameter

sourceFlags

ISPHttpClientConfiguration

Gibt zurück

SPHttpClientConfiguration