Die Header Abrufen Mit der API können Sie Header aus einer Liste von Anforderungs- oder Antwortheadern abrufen, festlegen, hinzufügen und entfernen.
Diese API ist Teil eines Satzes von Abrufen APIs, die verschiedene Aktionen zum Abrufen von Ressourcen von externen Websites bereitstellen. Der vollständige Abrufen Die API-Sammlung umfasst:
Zur Unterstützung von Abrufaktionen die Systemeigenschaft Glide.Hosts.Zulässigkeitsliste , Ermöglicht Steuerungen darüber, auf welche Hosts eine Abrufmethode zugreifen kann. Gilt für HTTP-APIs wie RestMessageV2 Und die oben genannten. Weitere Informationen zu finden Glide.Hosts.Zulässigkeitsliste , Siehe Available system properties.
Header abrufen – Header (init)
Die Header() Der Konstruktor erstellt ein neues, leeres Header-Objekt. Mit können Sie auch ein neues Header-Objekt mit einer Liste von HTTP-Headern erstellen und vorab ausfüllen initParameter.
Optional. Ein Objektliteral, das HTTP-Header enthält, mit denen das neue Header-Objekt vorab ausgefüllt werden soll.
Gültige Werte:
Ein Objektliteral mit Zeichenfolgenwerten,
Ein Array von Name-Wert-Paaren,
Ein vorhandenes Header-Objekt (in dem das neue Objekt Daten aus dem vorhandenen Objekt kopiert).
Standard: Erstellt ein leeres Header-Objekt
Das folgende Beispiel zeigt die Verwendung von Header() Konstruktor zum Erstellen eines neuen Header-Objekts mit und ohne Header.
//Intializes an empty Headers object.
var headers = new Headers();
//Sets the new Headers object with a list of headers.
var httpHeaders = {
"Content-Type": "application/json",
"X-My-Custom-Header": "XYZ",
};
var myHeaders = new Headers(httpHeaders);
Fügt einem vorhandenen Header in einem Header-Objekt einen neuen Wert hinzu, oder fügt den Header hinzu, wenn er nicht bereits vorhanden ist.
Wenn der angegebene Header bereits vorhanden ist, Anfügen() Ändert den vorhandenen Wert in den angegebenen Wert. Wenn der angegebene Header bereits vorhanden ist und mehrere Werte akzeptiert, Anfügen() Hängt den neuen Wert an das Ende des Wertsatzes an. Verwenden Sie , um den alten Wert mit einem neuen zu überschreiben Header abrufen – Set (Zeichenfolgenname, Zeichenfolgenwert).
Tabelle : 2. Parameter
Name
Typ
Beschreibung
Name
Zeichenfolge
Erforderlich. Der Name des HTTP-Headers, der dem Header-Objekt hinzugefügt werden soll.
Wert
Zeichenfolge
Erforderlich. Der Wert des hinzuzufügenden HTTP-Headers.
Tabelle : 3. Rückgaben
Typ
Beschreibung
Keine
Das folgende Beispiel zeigt, wie Sie mit einen Header hinzufügen Anfügen() :
var myHeaders = new Headers(); // Currently empty
myHeaders.append("Content-Type", "image/jpeg");
myHeaders.get("Content-Type"); // Returns 'image/jpeg'
Ausgabe:
“image/jpeg”
Das folgende Beispiel zeigt, wie Sie einen neuen Header anhängen, der mehrere Werte akzeptiert:
var myHeaders = new Headers(); // Currently empty
myHeaders.append("Accept-Encoding", "deflate");
myHeaders.append("Accept-Encoding", "gzip");
myHeaders.get("Accept-Encoding"); // Returns 'deflate, gzip'
Ausgabe:
{“deflate”, “gzip”}
Header abrufen – DELETE (Zeichenfolgenname)
Löscht einen Header aus dem aktuellen Header-Objekt.
Tabelle : 4. Parameter
Name
Typ
Beschreibung
Name
Zeichenfolge
Der Name des HTTP-Headers, der aus dem Header-Objekt gelöscht werden soll.
Tabelle : 5. Rückgaben
Typ
Beschreibung
Keine
Das folgende Beispiel zeigt, wie Sie mit dem Header-Objekt zuerst einen Header hinzufügen Anfügen() , Und löschen Sie dann denselben Header mit Löschen () .
var myHeaders =newHeaders();// Currently empty
myHeaders.append("Content-Type","image/jpeg");
myHeaders.get("Content-Type");// Returns 'image/jpeg'
Das folgende Beispiel zeigt, dass der Endpunkt einen Wert von Null zurückgibt, wenn das Header-Objekt bereits gelöscht wurde:
myHeaders.delete("Content-Type");
myHeaders.get("Content-Type");// Returns null, as it has been deleted
Ausgabe:
null
Header abrufen – entry()
Gibt einen Iterator zurück, mit dem Sie alle Schlüssel-Wert-Paare (dargestellt durch Zeichenfolgen) durchlaufen können, die im Header-Objekt enthalten sind.
Tabelle : 6. Parameter
Name
Typ
Beschreibung
Keine
Tabelle : 7. Ergebnisse
Typ
Beschreibung
Iterator
Gibt ein Iteratorobjekt zurück, bei dem sowohl die Schlüssel- als auch die Wertpaare Zeichenfolgenobjekte sind.
Das folgende Beispiel zeigt, wie ein Test-Header-Objekt erstellt und dann verwendet wird Einträge () Methode zum Rückgeben eines Iterators aller Werte im Header-Objekt.
// Create a test Headers object
var myHeaders = new Headers();
myHeaders.append("Content-Type", "text/xml");
myHeaders.append("Vary", "Accept-Language");
// Display the key/value pairs
for (var pair of myHeaders.entries()) {
console.log(`${pair[0]}: ${pair[1]}`);
}
Führt eine Rückruffunktion einmal pro Schlüssel-Wert-Paar im Header-Objekt aus.
Die Rückruffunktion wird nicht für gelöschte Schlüssel ausgeführt, sondern für vorhandene Schlüssel, auch wenn der Wert nicht definiert ist.
Tabelle : 8. Parameter
Name
Typ
Beschreibung
CallbackFn
Funktion
Funktion, die für jedes Schlüssel-Wert-Paar im Header-Objekt ausgeführt werden soll.
Entspricht dem folgenden Format: CallbackFn(Zeichenfolgenschlüssel, Zeichenfolgenwert) .
CallbackFn.value
Zeichenfolge
Wert des Headereintrags.
callbackFn.key
Zeichenfolge
Name des Headereintrags.
CallBackFn.object
Header
Das zu iterierende Header-Objekt.
DisArg
Objekt
Wert, als verwendet werden soll Dies Beim Ausführen Rückruf .
Tabelle : 9. Rückgaben
Typ
Beschreibung
Keine
Im folgenden Beispiel wird eine Zeile für jedes Schlüssel-Wert-Paar im Header-Objekt protokolliert:
// Create a new test Headers object
var myHeaders = new Headers();
myHeaders.append("Content-Type", "application/json");
myHeaders.append("Cookie", "This is a demo cookie");
myHeaders.append("compression", "gzip");
// Display the key/value pairs
myHeaders.forEach((value, key) => {
console.log(`${key} ==> ${value}`);
});
Ausgabe:
compression ==> gzip
content-type ==> application/json
cookie ==> This is a demo cookie
Header abrufen – GET(Zeichenfolgenname)
Gibt eine Zeichenfolge aller Headerwerte eines angegebenen Headerobjekts zurück oder gibt null zurück, wenn der Header nicht vorhanden ist.
Tabelle : 10. Parameter
Name
Typ
Beschreibung
Name
Zeichenfolge
Der Name des HTTP-Headers, dessen Headerwerte Sie abrufen möchten (Groß-/Kleinschreibung nicht beachten).
Tabelle : 11. Rückgaben
Typ
Beschreibung
Zeichenfolge
Der Wert des abgerufenen Headers (dargestellt als Zeichenfolge) oder Null, wenn der Header nicht festgelegt ist.
Gibt einen Fehler zurück, wenn der Header nicht vorhanden ist. Gibt einen Typfehler zurück, wenn der angegebene Name nicht der eines HTTP-Headers ist.
Im Folgenden wird gezeigt, wie Sie ein Header-Objekt mit mehreren Headern mit erstellen Anfügen() , Und gibt dann die Werte des Headers mit zurück Get() Methode.
var myHeaders = new Headers(); // Currently empty
myHeaders.append("Accept-Encoding", "deflate");
myHeaders.append("Accept-Encoding", "gzip");
myHeaders.get("Accept-Encoding"); // Returns "deflate, gzip"
myHeaders
.get("Accept-Encoding")
.split(",")
.map((v) => v.trimStart()); // Returns [ "deflate", "gzip"
Ausgabe:
[ "deflate", "gzip" ]
Header abrufen – getSetCookie()
Gibt alle Set-Cookie-Header zurück, die einer Antwort zugeordnet sind.
Tabelle : 12. Parameter
Name
Typ
Beschreibung
Keine
Tabelle : 13. Ergebnisse
Typ
Beschreibung
Array aus Zeichenfolgen
Ein Array von Zeichenfolgen, das die Werte aller Set-Cookie-Header enthält, die einer Antwort zugeordnet sind. Die Methode gibt ein leeres Array zurück, wenn keine Set-Cookie-Header festgelegt sind.
Das folgende Skriptbeispiel zeigt die Verwendung GetSetCookie() So geben Sie die Headerwerte zurück, die der Antwort zugeordnet sind:
var headers = new Headers({
"Set-Cookie": "name1=value1",
});
headers.append("Set-Cookie", "name2=value2");
headers.getSetCookie();
Ausgabe:
["name1=value1", "name2=value2"]
Header abrufen – hat(Zeichenfolgenname)
Gibt einen booleschen Wert zurück, der angibt, ob ein Header-Objekt den angegebenen Header enthält.
Tabelle : 14. Parameter
Name
Typ
Beschreibung
Name
Zeichenfolge
Der Name des HTTP-Headers, um zu überprüfen, ob er im Header-Objekt vorhanden ist oder nicht.
Tabelle : 15. Rückgaben
Typ
Beschreibung
Boolean
Kennzeichnung, die angibt, ob der angegebene Header im Header-Objekt vorhanden ist. Ein TypeError wird zurückgegeben, wenn der angegebene Header kein gültiger HTTP-Headername ist.
Mögliche Werte:
Wahr: Der Header ist für das Objekt vorhanden.
Falsch: Der Header ist für das Objekt nicht vorhanden.
Im folgenden Beispiel wird verwendet Header() Und Anfügen() Methoden zum Erstellen und Festlegen eines Header-Objekts mit dem Content-Type-Header. Im Beispiel wird dann verwendet Hat() Methode, um anzuzeigen, dass der Inhaltstyp-Header im Header-Objekt vorhanden ist, ein Header für die Akzeptanzcodierung jedoch nicht.
var myHeaders = new Headers(); // Currently empty
myHeaders.append("Content-Type", "image/jpeg");
myHeaders.has("Content-Type"); // Returns true
myHeaders.has("Accept-Encoding"); // Returns false
Ausgabe:
true
false
Header abrufen – Keys()
Gibt einen Iterator zurück, mit dem Sie alle Schlüssel durchlaufen können, die in einem Header-Objekt enthalten sind.
Gibt einen Iterator zurück, bei dem Header-Schlüssel als Zeichenfolgen dargestellt werden.
Das folgende Beispiel zeigt, wie ein Header-Objekt mit Schlüsseln erstellt und dann verwendet wird Schlüssel() Methode zum Rückgeben einer Liste verfügbarer Header.
// Create a test Headers object
var myHeaders = new Headers();
myHeaders.append("Content-Type", "text/xml");
myHeaders.append("Vary", "Accept-Language");
// Display the keys
for (var key of myHeaders.keys()) {
console.log(key);
}
Ausgabe:
content-type
vary
Header abrufen – Set (Zeichenfolgenname, Zeichenfolgenwert)
Aktualisiert einen Wert eines vorhandenen Headers im Header-Objekt oder erstellt einen neuen Header mit dem angegebenen Wert, wenn der Header nicht bereits vorhanden ist.
Der Name des HTTP-Headers, in dem ein neuer Wert festgelegt werden soll. Löst TypeError aus, wenn der angegebene Name nicht der Name eines HTTP-Headers ist.
Wert
Zeichenfolge
Der neue Wert, der für den angegebenen Header festgelegt werden soll.
Tabelle : 19. Rückgaben
Typ
Beschreibung
Keine
Das folgende Beispiel zeigt, wie Sie einen Header in einem neuen Header-Objekt mit festlegen Anfügen() , Und setzen Sie dann den Wert mit zurück Satz () .
var myHeaders = new Headers(); // Currently empty
myHeaders.append("Content-Type", "image/jpeg");
myHeaders.set("Content-Type", "text/html");
Ausgabe:
text/html
Das folgende Beispiel zeigt, wie ein Wert in einem Header-Objekt festgelegt wird, wenn mehrere Werte akzeptiert werden:
Gibt einen Iterator zurück, bei dem die Headerwerte als Zeichenfolgen dargestellt werden.
Das folgende Beispiel zeigt, wie Sie mithilfe von ein neues Header-Objekt mit mehreren Headern erstellen und festlegen Anfügen() Methode und gibt dann eine Liste aller Header-Werte im neuen Objekt zurück, indem aufgerufen wird Werte () Methode. Console.log() Protokolliert die Zeile in Systemprotokollen.
// Create a test Headers object
var myHeaders = new Headers();
myHeaders.append("Content-Type", "text/xml");
myHeaders.append("Vary", "Accept-Language");
// Display the values
for (var value of myHeaders.values()) {
console.log(value);
}