TsgcHTTP2ClientMethoden › Options

Options Methode

Führt einen synchronen HTTP/2-OPTIONS-Request durch, um die Kommunikationsoptionen einer Ressource zu ermitteln.

Überladungen

Overload 1

Syntax

function Options(const aURL: string): string;

Parameter

NameTypBeschreibung
aURLconst stringAbsolute URL der Ressource, deren Fähigkeiten abgefragt werden, oder *, um den Server als Ganzes abzufragen.

Rückgabewert

Vom Server als Zeichenfolge zurückgegebener Antwortkörper; die nützlichen Informationen befinden sich in der Regel in den Antwort-Headern. (string)

Hinweise

OPTIONS wird häufig von Browsern für CORS-Preflight und von Clients verwendet, um zu prüfen, welche Methoden akzeptiert werden. Untersuchen Sie Request.Headers nach dem Aufruf, um die allow-, access-control-allow-*- und verwandten Header zu lesen.

Beispiel

vResponse := oClient.Options('https://api.example.com/v1/users');

Überladung 2

Syntax

procedure Options(Const aURL: string; const aResponseContent: TStream);

Parameter

NameTypBeschreibung
aURLconst stringAbsolute URL der abgefragten Ressource.
aResponseContentconst TStreamVom Aufrufer verwalteter Stream, der den Antworttext empfängt, falls der Server einen zurückgibt.

Hinweise

Stream-basierte Variante von OPTIONS. Verwenden Sie sie, wenn die Antwort-Payload an einen beliebigen TStream geleitet werden soll, anstatt als Zeichenfolge materialisiert zu werden.

Beispiel

oOut := TMemoryStream.Create;
try
  oClient.Options('https://api.example.com/v1/users', oOut);
finally
  oOut.Free;
end;

Zurück zu Methoden